Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: SyncMLHistory.h
Link against: smlclient.lib

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

Class CSyncMLHistoryEntry

class CSyncMLHistoryEntry : public CBase;

Description

Base class for a history log entry.

Not intended for user derivation. Derived classes:

Derivation

Members

Defined in CSyncMLHistoryEntry:
ESortByTime, ESortByType, EntryId(), EntryType(), ExternalizeL(), InternalizeL(), NewL(), NewL(), NewL(), Profile(), Reserved(), ResultCode(), TSortOrder, TimeStamp(), ~CSyncMLHistoryEntry()

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

See also:


Construction and destruction


NewL()

static IMPORT_C CSyncMLHistoryEntry *NewL(TUid aEntryType);

Description

This method creates a new history log entry of the specified type.

Parameters

TUid aEntryType

The unique ID of the type of entry to create.

Return value

CSyncMLHistoryEntry *

A new entry instance of the type specified by aEntryType.

Leave codes

KErrNotSupported

If the entry type is unknown.


NewL()

static IMPORT_C CSyncMLHistoryEntry *NewL(RReadStream &);

Description

This method creates a new history log entry from a stream, internalizing all data.

Parameters

RReadStream &

A stream containing a valid History Log entry.

Return value

CSyncMLHistoryEntry *

A new entry instance of the type specified in aStream.

Leave codes

KErrNotSupported

If the entry type is unknown.


NewL()

static IMPORT_C CSyncMLHistoryEntry *NewL(const CSyncMLHistoryEntry &);

Description

This method creates a new copy of an existing History Log entry.

Parameters

const CSyncMLHistoryEntry &

The entry to copy.

Return value

CSyncMLHistoryEntry *

A new copy of the specified entry.

Leave codes

KErrNotSupported

If the entry type is unknown.


~CSyncMLHistoryEntry()

virtual IMPORT_C ~CSyncMLHistoryEntry();

Description

Default destructor for CSyncMLHistoryEntry.

[Top]


Member functions


ExternalizeL()

virtual IMPORT_C void ExternalizeL(RWriteStream &) const;

Description

This method writes the details associated with this entry to the specified stream.

Parameters

RWriteStream &

The stream to write the entry to.


EntryType()

IMPORT_C TUid EntryType() const;

Description

This method may be used to determine the type of the entry.

Return value

TUid

The unique ID of the type of this entry.


EntryId()

IMPORT_C TInt EntryId() const;

Description

This method returns the unique ID of the entry. This identifier is unique within the History Log.

Return value

TInt

The unique ID of this entry.


Profile()

virtual TSmlProfileId Profile() const=0;

Description

Return value

TSmlProfileId


TimeStamp()

virtual TTime TimeStamp() const=0;

Description

Return value

TTime


ResultCode()

virtual TInt ResultCode() const=0;

Description

Return value

TInt


InternalizeL()

protected: virtual void InternalizeL(RReadStream &);

Description

Parameters

RReadStream &


Reserved()

private: virtual IMPORT_C TAny *Reserved(TUid);

Description

Parameters

TUid

Return value

TAny *

[Top]


Member enumerations


Enum TSortOrder

TSortOrder

Description

An ordering of History Entries.

ESortByTime

Ordered by Time Stamp.

ESortByType

Ordered by Entry Type.