Collapse all Symbian^3 Application Developer Library

TAgnEntryId Class Reference

class TAgnEntryId

The base class for agenda entry and instance ID types. Internally, the ID is stored as a 32-bit unsigned integer.

This is made up of a stream ID which stores the stream containing the entry, and a partial ID, which gives the position of the entry within that stream. There can be up to EMaxNumEntriesPerStream entries in a stream (16).

Public Member Functions
	TAgnEntryId ()
	TAgnEntryId (const TStreamId &, TUint )
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TBool	IsNullId ()
IMPORT_C TUint	PartialId ()
void	SetStreamId (const TStreamId &)
TStreamId	StreamId ()
TUint	Value ()
IMPORT_C TBool	operator!= (const TAgnEntryId &)
IMPORT_C TBool	operator== (const TAgnEntryId &)

Private Member Functions
void	SetPartialId ( TUint )

Protected Attributes
TUint32	iId

Constructor & Destructor Documentation

TAgnEntryId()

IMPORT_C

TAgnEntryId

(

)

TAgnEntryId(const TStreamId &, TUint)

IMPORT_C	TAgnEntryId	(	const TStreamId &	aStreamId,
			TUint	aPartialId
		)

Parameters

const TStreamId & aStreamId
TUint aPartialId

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises the ID to a write stream.

The presence of this function means that the standard templated operator<<() is available to externalise objects of this class.

Parameters

RWriteStream & aStream

Stream to which the ID should be externalised.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises the ID from a read stream.

The presence of this function means that the standard templated operator>>() is available to internalise objects of this class.

Parameters

RReadStream & aStream

Stream from which the ID should be internalised.

IsNullId()

IMPORT_C TBool

IsNullId

(

)

const

Tests whether the ID value has been set.

If not set, its value is zero.

PartialId()

IMPORT_C TUint

PartialId

(

)

const

SetPartialId(TUint)

void

SetPartialId

(

TUint

aId

)

[private]

Parameters

TUint aId

SetStreamId(const TStreamId &)

void

SetStreamId

(

const TStreamId &

aId

)

Parameters

const TStreamId & aId

StreamId()

TStreamId

StreamId

(

)

const [inline]

Value()

TUint

Value

(

)

const [inline]

operator!=(const TAgnEntryId &)

IMPORT_C TBool

operator!=

(

const TAgnEntryId &

aId

)

const

Compares two IDs for inequality.

Parameters

const TAgnEntryId & aId

The ID to compare with this one.

operator==(const TAgnEntryId &)

IMPORT_C TBool

operator==

(

const TAgnEntryId &

aId

)

const

Compares two IDs for equivalence.

Parameters

const TAgnEntryId & aId

The ID to compare with this one.

Member Data Documentation

TUint32 iId

TUint32

iId

[protected]