class TTaskInfo |
Contains detailed information for a single task.
A schedule can have any number of tasks. An object of this type is passed to RScheduler::ScheduleTask() . Objects of this type are also returned by functions within RScheduler that retrieve information about tasks.
RScheduler::ScheduleTask() RScheduler::GetScheduleL() RScheduler::GetTaskInfoL()
Public Member Functions | |
---|---|
TTaskInfo ( TInt , TName &, TInt , TInt ) | |
TTaskInfo () | |
IMPORT_C void | ExternalizeL ( RWriteStream &) |
IMPORT_C void | InternalizeL ( RReadStream &) |
IMPORT_C TTaskInfo & | operator= (const TTaskInfo &) |
Public Attributes | |
---|---|
TName | iName |
TInt | iPriority |
TInt | iRepeat |
TInt | iTaskId |
IMPORT_C | TTaskInfo | ( | TInt | aTaskId, |
TName & | aName, | |||
TInt | aPriority, | |||
TInt | aRepeat | |||
) |
Constructor taking the specified parameters.
IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
Externalises an object of this class to a write stream.
The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.
RWriteStream & aStream | Stream to which the object should be externalised. |
IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
Internalises an object of this class from a read stream.
The presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.
Note that the function has assignment semantics. It replaces the old value of the object with a new value read from the read stream.
RReadStream & aStream | Stream from which the object is to be internalised. |
IMPORT_C TTaskInfo & | operator= | ( | const TTaskInfo & | aTaskInfo | ) |
const TTaskInfo & aTaskInfo |
TInt | iPriority |
The priority of the task.
This is defined by the client.
Determines the order in which a client's tasks are executed. Where a client has two tasks with different priorities, the task with the higher priority will be executed first.
TInt | iRepeat |
Specifies how often the task is to be repeated.
This is defined by the client.
A value of 1 means once, a value of 2 means twice etc.
Note that zero is interpreted to mean once, and a negative value is interpreted to mean that the task will be repeated until it is explicitly deleted.
TInt | iTaskId |
The unique Id for the task.
This is generated by the Task Scheduler. Clients should use the generated Id to refer to the task in future transactions.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.