Class TAgnReplicationData

TAgnReplicationData

Support

Supported from 5.0

Description

Stores the synchronisation data associated with each agenda entry and to-do list. This data is used when an EPOC agenda file is synchronised with a PC or other scheduler. The synchronisation data consists of:

• a last changed date/time

• a status (controls access rights to the entry / to-do list)

• a synchronisation count (prevents synchronised entries or to-do lists from being fully deleted until they are no longer needed for synchronisation)

• a flag which indicates whether or not the entry / to-do list has been marked as deleted but cannot be fully deleted until its synchronisation count is zero

Defined in TAgnReplicationData:
Count(), DecCount(), EOpen, EPrivate, ERestricted, ExternalizeL(), HasBeenDeleted(), IncCount(), InternalizeL(), LastChangedDate(), Reset(), SetCount(), SetHasBeenDeleted(), SetLastChangedDate(), SetStatus(), Status(), TAgnReplicationData(), TStatus

TAgnReplicationData();

Description

The default C++ constructor constructs a replication data object, initialising the status to EOpen, the ‘has been deleted’ flag to EFalse, the synchronisation count to zero, and the last changed date / time to the current universal date / time.

void SetCount(TUint aCount);

Description

Sets the synchronisation count.

Parameters

TUint aCount The count to be set.

void IncCount();

Description

Increments the synchronisation count.

void DecCount();

Description

Decrements the synchronisation count.

void SetHasBeenDeleted(TBool aHasBeenDeleted);

Description

Sets the ‘has been deleted’ flag to the specified value.

Parameters

TBool aHasBeenDeleted True to set the flag, False to clear the flag.

void SetLastChangedDate();

Description

Sets the last changed date / time to the current universal date / time.

void SetStatus(TStatus aStatus);

Description

Sets the status for an agenda entry or to-do list.

Parameters

TStatus aStatus The status.

void Reset();

Description

Resets the replication data to the default values. For details, see the documentation of the constructor.

TUint Count() const;

Description

Gets the synchronisation count.

Return value

TUint The count.

TBool HasBeenDeleted() const;

Description

Tests whether the ‘has been deleted’ flag is set.

Return value

TBool True = the flag is set, otherwise False.

TTime LastChangedDate() const;

Description

Gets the last changed date/time for the agenda entry or to-do list.

Return value

TTime The last changed date/time.

TStatus Status() const;

Description

Gets the status for the agenda entry/to-do list.

Return value

TStatus The status.

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises the synchronisation data to a write stream.

Parameters

RWriteStream& aStream The stream to which the object should be externalised.

Leave codes

Leaves with KErrCorrupt if the status is not one of the three valid values.

void InternalizeL(RReadStream& aStream);

Description

Internalises the synchronisation data from a read stream. Panics if the status read in is not one of the three valid values.

Parameters

RReadStream& aStream The stream from which the object should be internalised.

TStatus

Description

Status

EOpen No restriction on access. The default. EPrivate Data is private (no access). ERestricted Data is confidential (restricted access).