Collapse all Symbian^3 Application Developer Library

TAiwGenericParam Class Reference

class TAiwGenericParam

Generic parameter class for passing data between applications. A generic parameter is a pair of semantic ID and variant value. The semantic ID tells the purpose of the parameter, for example a file name, URL or phone number. The variant value contains the data format and actual value. This class does not implement any consistency checks between the semantic ID and value's data format. So one semantic ID can be expressed as alternative data formats.

ServiceHandler.lib

Since: Series 60 2.6

TAiwVariant CAiwGenericParamList

Public Member Functions
	TAiwGenericParam ()
	TAiwGenericParam ( TGenericParamId )
	TAiwGenericParam ( TGenericParamId , const TAiwVariant &)
void	Reset ()
TGenericParamId	SemanticId ()
void	SetSemanticId ( TGenericParamId )
TAiwVariant &	Value ()
const TAiwVariant &	Value ()

Private Member Functions
void	CleanupDestroy ( TAny *)
void	CopyLC (const TAiwGenericParam &)
void	Destroy ()
void	ExternalizeL ( RWriteStream &)
void	InternalizeL ( RReadStream &)
TInt	Size ()
	operator TCleanupItem ()

Private Attributes
TAny *	iReserved
TGenericParamId	iSemanticId
TAiwVariant	iValue

Constructor & Destructor Documentation

TAiwGenericParam()

TAiwGenericParam

(

)

[inline]

Constructs a generic parameter.

TAiwGenericParam(TGenericParamId)

TAiwGenericParam

(

TGenericParamId

aSemanticId

)

[inline]

Constructs a generic parameter.

Parameters

TGenericParamId aSemanticId

The semantic ID of the parameter, one of TGenericParamId values.

TAiwGenericParam(TGenericParamId, const TAiwVariant &)

TAiwGenericParam	(	TGenericParamId	aSemanticId,
		const TAiwVariant &	aValue
	)	[inline]

Constructs a generic parameter.

Parameters

TGenericParamId aSemanticId	The semantic ID of the parameter, one of TGenericParamId values.
const TAiwVariant & aValue	The parameter value.

Member Functions Documentation

CleanupDestroy(TAny *)

void

CleanupDestroy

(

TAny *

aObj

)

[private, static]

Callback for operator TCleanupItem().

Parameters

TAny * aObj

CopyLC(const TAiwGenericParam &)

void

CopyLC

(

const TAiwGenericParam &

aParam

)

[private]

Copies aParam to this parameter. Takes an own copy of the value held in aParam.

Parameters

const TAiwGenericParam & aParam

Destroy()

void

Destroy

(

)

[private, inline]

Releases any dynamic data owned by this parameter.

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const [private]

Externalizes this parameter to aStream.

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

aStream

)

[private]

Internalizes this parameter from aStream.

Parameters

RReadStream & aStream

Reset()

void

Reset

(

)

[inline]

Resets the semantic ID and the value of this parameter.

SemanticId()

TGenericParamId

SemanticId

(

)

const [inline]

Returns the semantic ID of this parameter.

SetSemanticId(TGenericParamId)

void

SetSemanticId

(

TGenericParamId

aSemanticId

)

[inline]

Sets the semantic ID. Possibly set previous ID is overwritten.

Parameters

TGenericParamId aSemanticId

The semantic ID of the parameter.

Size()

TInt

Size

(

)

const [private]

Returns the maximum externalized size of this parameter.

Value()

TAiwVariant &

Value

(

)

[inline]

Returns the value of this parameter.

Value()

const TAiwVariant &

Value

(

)

const [inline]

Returns the const value of this parameter.

operator TCleanupItem()

operator TCleanupItem

(

)

[private]

Returns a cleanup item that will call Destroy to this object when PopAndDestroy'ed.

Member Data Documentation

TAny * iReserved

TAny *

iReserved

[private]

TGenericParamId iSemanticId

TGenericParamId

iSemanticId

[private]

TAiwVariant iValue

TAiwVariant

iValue

[private]