Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: MsvEntryScheduleData.h
Link against: schsend.lib

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

Class TMsvEntryScheduleData

class TMsvEntryScheduleData;

Description

Stores message-specific data related to scheduling.

The data is not required by the Client/UI side. This data is stored in a stream associated with the TMsvEntry.

Members

Defined in TMsvEntryScheduleData:
IncreaseRetries(), IsReset(), RemoveL(), Reset(), ResetRetries(), RestoreL(), Retries(), StoreL(), TMsvEntryScheduleData(), iRef, iRetryCount, iTaskId, iVersion


Construction and destruction


TMsvEntryScheduleData()

IMPORT_C TMsvEntryScheduleData();

Description

Default constructor.

[Top]


Member functions


RestoreL()

IMPORT_C void RestoreL(CMsvStore &aStore);

Description

Restores the object from a store.

Parameters

CMsvStore &aStore

Store to read from.


StoreL()

IMPORT_C void StoreL(CMsvStore &aStore) const;

Description

Stores the object in a store.

This method leaves if the the object's data cannot be written to a RMsvWriteStream stream.

Parameters

CMsvStore &aStore

Store to write to.


RemoveL()

IMPORT_C void RemoveL(CMsvStore &aStore) const;

Description

Removes the object from a store.

Parameters

CMsvStore &aStore

Store to remove from.

Leave codes

CMsvStore::IsPresentL()

CMsvStore::RemoveL()


Reset()

IMPORT_C void Reset();

Description

Resets the object.

It sets all member data to zero.


IsReset()

IMPORT_C TBool IsReset() const;

Description

Tests if all the members are set to their default value.

Return value

TBool

True if all the members are set to their default value.


Retries()

IMPORT_C TInt Retries() const;

Description

Gets how many retries have been made to send this message.

Return value

TInt

Number of retries.


IncreaseRetries()

IMPORT_C void IncreaseRetries();

Description

Adds one to the value of the iRetryCount member.


ResetRetries()

IMPORT_C void ResetRetries();

Description

Sets the iRetryCount member to zero.

[Top]


Member data


iTaskId

TInt iTaskId;

Description

The Task ID returned by the Task Scheduler when the message is scheduled.


iRef

TSchedulerItemRef iRef;

Description

The TSchedulerItemRef returned by the Task Scheduler when the schedule on which the message is scheduled is created.


iRetryCount

protected: TInt iRetryCount;

Description

The number of retries that have been made to send this message.


iVersion

protected: TInt16 iVersion;

Description

Structure version.