Collapse all Symbian^3 Product Developer Library

CAiwGenericParamList Class Reference

class CAiwGenericParamList : public CBase

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

ServiceHandler.lib

Since: Series 60 2.6

Inherits from

CAiwGenericParamList
- CBase

Public Member Functions
	~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)

Private Member Functions
	CAiwGenericParamList()
void	AppendL(RReadStream &)
void	ConstructL()

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()

Private Attributes
RArray< TAiwGenericParam >	iParameters

Constructor & Destructor Documentation

CAiwGenericParamList()

CAiwGenericParamList

(

)

[private, inline]

~CAiwGenericParamList()

~CAiwGenericParamList

(

)

[virtual]

Destructor.

Member Functions Documentation

AppendL(const TAiwGenericParam &)

IMPORT_C void

AppendL

(

const TAiwGenericParam &

aParam

)

Appends a parameter to this list.

Parameters

const TAiwGenericParam & 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

Parameters

const CAiwGenericParamList & aList

A list to be copied and appended.

AppendL(RReadStream &)

void

AppendL

(

RReadStream &

aReadStream

)

[private]

Appends parameters to this list from aStream.

Parameters

RReadStream & aReadStream

ConstructL()

void

ConstructL

(

)

[private]

Count()

IMPORT_C TInt

Count

(

)

const

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.

Parameters

TGenericParamId aSemanticId	The semantic ID of the parameter.
TVariantTypeId aDataType = EVariantTypeAny	The type id of data. Default is any type.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes this parameter list to a stream.

NewL(RReadStream& aStream) NewLC(RReadStream& aStream)

Parameters

RWriteStream & 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.

Parameters

TInt & 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.
TGenericParamId aSemanticId	The semantic ID of the parameter.
TVariantTypeId aDataType = EVariantTypeAny	The type id of data. Default is any type.

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.

Parameters

TInt & 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.
TGenericParamId aSemanticId	The semantic ID of the parameter.
TVariantTypeId aDataType = EVariantTypeAny	The type id of data. Default is any type.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalizes the parameter list from a stream.

Since: Series60 2.8

Parameters

RReadStream & aStream

The stream.

NewL()

IMPORT_C CAiwGenericParamList *

NewL

(

)

[static]

Creates an instance of this class.

NewL(RReadStream &)

IMPORT_C CAiwGenericParamList *

NewL

(

RReadStream &

aReadStream

)

[static]

Creates an instance of this class.

Parameters

RReadStream & aReadStream

A stream to initialize this parameter list from.

NewLC()

IMPORT_C CAiwGenericParamList *

NewLC

(

)

[static]

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

NewLC(RReadStream &)

IMPORT_C CAiwGenericParamList *

NewLC

(

RReadStream &

aReadStream

)

[static]

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

Parameters

RReadStream & aReadStream

A stream to initialize this parameter list from.

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

Parameters

TIpcArgs & aArgs

Inter process call arguments.

Remove(TInt)

IMPORT_C TBool

Remove

(

TInt

aSemanticId

)

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

Parameters

TInt aSemanticId

Semantic id for the item to be removed.

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.

UnpackFromClientL(const RMessage2 &)

IMPORT_C void

UnpackFromClientL

(

const RMessage2 &

aArgs

)

Unpacks the list from client message structure.

Since: Series60 3.0

Parameters

const RMessage2 & 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()

Parameters

TInt aIndex

Index of the parameter.

Member Data Documentation

RArray< TAiwGenericParam > iParameters

RArray< TAiwGenericParam >

iParameters

[private]