TTaskInfo Class Reference

#include <schinfo.h>

Link against: schsvr.lib

class TTaskInfo
Public Attributes
TName iName
TInt iPriority
TInt iRepeat
TInt iTaskId
Public Member Functions
TTaskInfo(TInt, TName &, TInt, TInt)
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TTaskInfo &operator=(const TTaskInfo &)

Detailed Description

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.

See also: RScheduler::ScheduleTask() RScheduler::GetScheduleL() RScheduler::GetTaskInfoL()

Member Attribute Documentation


TName iName

The name of the task.

This is defined by the client.

See also: TName


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.

Constructor & Destructor Documentation

TTaskInfo ( TInt, TName &, TInt, TInt )

TName &aName,

Constructor taking the specified parameters.

aTaskIdThe task Id.
aNameThe name of the task.
aPriorityThe task priority.
aRepeatHow often the task is to be repeated

TTaskInfo ( )


Default constructor.

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(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.

aStreamStream to which the object should be externalised.

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(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.

aStreamStream from which the object is to be internalised.

operator= ( const TTaskInfo & )

IMPORT_C TTaskInfo &operator=(const TTaskInfo &aTaskInfo)