CAiwGenericParamList Class Reference

#include <mw/AiwGenericParam.h>

Link against: ServiceHandler.lib

class CAiwGenericParamList : public CBase

Inherits from

CAiwGenericParamList

Public Member Functions
virtual	~CAiwGenericParamList()
IMPORT_C void	AppendL(const TAiwGenericParam &)
IMPORT_C void	AppendL(const CAiwGenericParamList &)
IMPORT_C TInt	Count()
IMPORT_C TInt	Count(TGenericParamId, TVariantTypeId)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C const TAiwGenericParam *	FindFirst(TInt &, TGenericParamId, TVariantTypeId)
IMPORT_C const TAiwGenericParam *	FindNext(TInt &, TGenericParamId, TVariantTypeId)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C CAiwGenericParamList *	NewL()
IMPORT_C CAiwGenericParamList *	NewL(RReadStream &)
IMPORT_C CAiwGenericParamList *	NewLC()
IMPORT_C CAiwGenericParamList *	NewLC(RReadStream &)
IMPORT_C HBufC8 *	PackForServerL(TIpcArgs &)
IMPORT_C TBool	Remove(TInt)
IMPORT_C void	Reset()
IMPORT_C TInt	Size()
IMPORT_C void	UnpackFromClientL(const RMessage2 &)
IMPORT_C const TAiwGenericParam &	operator[](TInt)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Generic parameter list. A list containing TAiwGenericParam objects. Used for passing parameters between consumers and providers.

Since: Series 60 2.6

Constructor & Destructor Documentation

~CAiwGenericParamList ( )

~CAiwGenericParamList

(

)

[virtual]

Destructor.

Member Function Documentation

AppendL ( const TAiwGenericParam & )

IMPORT_C void

AppendL

(

const TAiwGenericParam &

aParam

)

Appends a parameter to this list.

Parameter	Description
aParam	The parameter to append to this list. This object takes an own copy of the data in aParam.

AppendL ( const CAiwGenericParamList & )

IMPORT_C void

AppendL

(

const CAiwGenericParamList &

aList

)

Copies the given list and appends it to end of this list.

Since: Series 60 2.8

Parameter	Description
aList	A list to be copied and appended.

Count ( )

IMPORT_C TInt

Count

(

)

const

Returns the number of parameters in the list.

Returns: The number of parameters in the list.

Count ( TGenericParamId, TVariantTypeId )

IMPORT_C TInt	Count	(	TGenericParamId	aSemanticId,
			TVariantTypeId	aDataType = EVariantTypeAny
		)	const

Returns the number of the parameters in the list by semantic id and datatype.

Parameter	Description
aSemanticId	The semantic ID of the parameter.
aDataType	The type id of data. Default is any type.

Returns: The number of parameters in the list by semantic id and datatype.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes this parameter list to a stream.

Parameter	Description
aStream	The stream.

FindFirst ( TInt &, TGenericParamId, TVariantTypeId )

IMPORT_C const TAiwGenericParam *	FindFirst	(	TInt &	aIndex,
			TGenericParamId	aSemanticId,
			TVariantTypeId	aDataType = EVariantTypeAny
		)	const

Returns the first item matching the given semantic ID.

Parameter	Description
aIndex	Position in which to start searching. On return it contains the position of the found parameter. It is set to KErrNotFound, if no matching items were found.
aSemanticId	The semantic ID of the parameter.
aDataType	The type id of data. Default is any type.

Returns: The first matching item.

FindNext ( TInt &, TGenericParamId, TVariantTypeId )

IMPORT_C const TAiwGenericParam *	FindNext	(	TInt &	aIndex,
			TGenericParamId	aSemanticId,
			TVariantTypeId	aDataType = EVariantTypeAny
		)	const

Returns the next item matching the given semantic ID.

Parameter	Description
aIndex	Position after which to start searching. On return it contains the position of the found parameter. It is set to KErrNotFound, if no matching items were found.
aSemanticId	The semantic ID of the parameter.
aDataType	The type id of data. Default is any type.

Returns: The next matching item.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalizes the parameter list from a stream.

Since: Series60 2.8

Parameter	Description
aStream	The stream.

NewL ( )

IMPORT_C CAiwGenericParamList *

NewL

(

)

[static]

Creates an instance of this class.

Returns: A pointer to the new instance.

NewL ( RReadStream & )

IMPORT_C CAiwGenericParamList *

NewL

(

RReadStream &

aReadStream

)

[static]

Creates an instance of this class.

Parameter	Description
aReadStream	A stream to initialize this parameter list from.

Returns: A pointer to the new instance.

NewLC ( )

IMPORT_C CAiwGenericParamList *

NewLC

(

)

[static]

Creates an instance of this class. Leaves the created instance on the cleanup stack.

Returns: A pointer to the new instance.

NewLC ( RReadStream & )

IMPORT_C CAiwGenericParamList *

NewLC

(

RReadStream &

aReadStream

)

[static]

Creates an instance of this class. Leaves the created instance on the cleanup stack.

Parameter	Description
aReadStream	A stream to initialize this parameter list from.

Returns: A pointer to the new instance.

PackForServerL ( TIpcArgs & )

IMPORT_C HBufC8 *

PackForServerL

(

TIpcArgs &

aArgs

)

Packs the parameter list to TIpcArgs structure for passing the generic param list to server over process boundary. Only one RFile handle parameter can be passed over process boundary.

Since: Series60 3.0

Parameter	Description
aArgs	Inter process call arguments.

Returns: Packed parameter list.

Remove ( TInt )

IMPORT_C TBool

Remove

(

TInt

aSemanticId

)

Removes the first found item with given semantic id from the list.

Parameter	Description
aSemanticId	Semantic id for the item to be removed.

Returns: ETrue if an item for the given semantic id was found and removed. EFalse otherwise.

Reset ( )

IMPORT_C void

Reset

(

)

Deletes all parameters in the list and resets the list.

Size ( )

IMPORT_C TInt

Size

(

)

const

Returns the externalized size of the parameter list in bytes.

Returns: The size.

UnpackFromClientL ( const RMessage2 & )

IMPORT_C void

UnpackFromClientL

(

const RMessage2 &

aArgs

)

Unpacks the list from client message structure.

Since: Series60 3.0

Parameter	Description
aArgs	The list to be unpacked.

operator[] ( TInt )

IMPORT_C const TAiwGenericParam &

operator[]

(

TInt

aIndex

)

const

Returns a parameter from this list.

Pre-condition: aIndex>=0 && aIndex<Count()

Parameter	Description
aIndex	Index of the parameter.

Returns: The parameter at the aIndex position.