Class TAgnId

TAgnId

Support

Supported from 5.0

Description

The base class for agenda entry and to-do list ID types.

Internally, stores the ID as a 32-bit unsigned integer. The interface to agenda entry and to-do list IDs is provided by the derived classes, including TAgnEntryId and TAgnTodoListId.

Defined in TAgnId:
ExternalizeL(), Id(), InternalizeL(), IsNullId(), SetNullId(), operator!=(), operator<(), operator==(), operator>()

void InternalizeL(RReadStream& aStream);

Description

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.

void ExternalizeL(RWriteStream& aStream) const;

Description

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.

TBool operator!=(TAgnId aId) const;

Description

Compares two IDs for inequality.

Parameters

TAgnId aId The ID to compare with this one.

Return value

TBool True if aId is different from this ID. False if they are the same.

TBool operator==(TAgnId aId) const;

Description

Compares two IDs for equivalence.

Parameters

TAgnId aId The ID to compare with this one.

Return value

TBool True if aId is equal to this ID. False if they are different.

TBool operator<(TAgnId aId) const;

Description

Tests whether this ID is less than another.

Parameters

TAgnId aId The ID to compare with this one.

Return value

TBool True if this ID is less than aId. False if not.

TBool operator>(TAgnId aId) const;

Description

Tests whether this ID is greater than another.

Parameters

TAgnId aId The ID to compare with this one.

Return value

TBool True if this ID is greater than aId. False if not.

TAgnId Id() const;

Description

Gets the ID value.

Return value

TAgnId The ID value.

TBool IsNullId() const;

Description

Tests whether the ID value has been set. If not set, its value is zero.

Return value

TBool True if the ID value is zero. False if not.

void SetNullId();

Description

Sets the ID value to zero.