Class RSyncMLHistoryLog

class RSyncMLHistoryLog : public RSubSessionBase;

Description

Snapshot of history for a profile.

Derivation

• RSubSessionBase - Client-side handle to a sub-session

• RSyncMLHistoryLog - Snapshot of history for a profile

Members

Defined in RSyncMLHistoryLog:
Close(), Count(), DeleteAllEntriesL(), Entry(), OpenL(), Profile(), RSyncMLHistoryLog(), SortEntries(), operator[]()

Inherited from RSubSessionBase:
CloseSubSession(), CreateAutoCloseSubSession(), CreateSubSession(), Send(), SendReceive(), Session(), SubSessionHandle()

IMPORT_C RSyncMLHistoryLog();

Description

Default constructor.

IMPORT_C void OpenL(RSyncMLSession &, TSmlProfileId);

Pre-Condition

The session is open.

Description

Opens a snapshot of the History Log for the Profile of the specified ID.

Parameters

RSyncMLSession & An open session with the Sync Agent. TSmlProfileId The ID of the profile to retrieve History for. KSmlNullId retrieves History not associated with any specific Profile.

Leave codes

System error codes.

IMPORT_C void SortEntries(CSyncMLHistoryEntry::TSortOrder);

Pre-Condition

The handle is open.

Description

Sorts the client-side list of cached entries into the specified order.

Parameters

CSyncMLHistoryEntry::TSortOrder The sort order for the entries.

Capability:

WriteDeviceData

IMPORT_C void DeleteAllEntriesL();

Pre-Condition

The handle is open.

Description

Deletes all the History stored for this profile.

IMPORT_C TSmlProfileId Profile() const;

Pre-Condition

The handle is open.

Description

Returns the ID of the Profile that this History relates to.

Return value

TSmlProfileId The Profile ID.

IMPORT_C TInt Count() const;

Pre-Condition

The handle is open.

Description

Returns the number of entries stored for this Profile History.

Return value

TInt The number of entries.

IMPORT_C const CSyncMLHistoryEntry &Entry(TInt aIndex) const;

Pre-Condition

The handle is open.

Description

Returns the entry at the specified index.

Parameters

TInt aIndex The index of the entry to retrieve.

Return value

const CSyncMLHistoryEntry & The number of entries.

inline const CSyncMLHistoryEntry &operator[](TInt aIndex) const;

Pre-Condition

The handle is open.

Description

Returns the entry at the specified index.

Parameters

TInt aIndex The index of the entry to retrieve.

Return value

const CSyncMLHistoryEntry & The entry at the specified index.

IMPORT_C void Close();

Description

Closes the History snapshot.