Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: CNTFLDST.H
Link against: cntmodel.lib

Class CContactAgentField

class CContactAgentField : public CContactFieldStorage;

Description

Provides access to an agent ID.

An agent is a field in a contact item which contains another person's contact details. It corresponds to the agent property in the vCard specification (version 2.1). The agent is identified by an agent ID (a TContactItemId).

An object of this class can be retrieved using CContactItemField::AgentStorage().

Derivation

Members

Defined in CContactAgentField:
CContactFieldStorage_Reserved1(), ExternalizeL(), InternalizeL(), IsFull(), RestoreL(), SetAgentId(), StoreL(), Value()

Inherited from CBase:
Delete(), Extension_(), operator new()


Member functions


StoreL()

virtual TStreamId StoreL(CStreamStore &aStore) const;

Description

Stores the field data.

Parameters

CStreamStore &aStore

Reference to the stream store to which the field data is written.

Return value

TStreamId

The ID of the stream store.


RestoreL()

virtual void RestoreL(CStreamStore &aStore, RReadStream &aStream);

Description

Restores the field data.

Parameters

CStreamStore &aStore

Reference to the store from which the object is to be restored.

RReadStream &aStream

Reference to the stream which should be passed to InternalizeL().


SetAgentId()

IMPORT_C void SetAgentId(TContactItemId aId);

Description

Sets the agent ID field data.

Parameters

TContactItemId aId

The agent ID. Must be > 0 otherwise it won't be set.


Value()

IMPORT_C TContactItemId Value() const;

Description

Gets the agent ID field data.

Return value

TContactItemId

The agent ID.


InternalizeL()

virtual void InternalizeL(RReadStream &aStream);

Description

Internalises the field data.

Parameters

RReadStream &aStream

Stream from which the the contents of the field should be internalised.


ExternalizeL()

virtual void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the field data.

Parameters

RWriteStream &aStream

Write stream to which the contents of the field should be externalised.


IsFull()

virtual TBool IsFull() const;

Description

Tests whether the field storage contains data.

Return value

TBool

True if the field storage contains data, false if not.


CContactFieldStorage_Reserved1()

private: virtual IMPORT_C void CContactFieldStorage_Reserved1();

Description