Class TTaskInfo

class TTaskInfo;

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(TTaskInfo &,HBufC &,const TInt). Objects of this type are also returned by functions within RScheduler that retrieve information about tasks.

Members

Defined in TTaskInfo:

• ExternalizeL(RWriteStream &)constExternalises an object of this class to a write stream.
• InternalizeL(RReadStream &)Internalises an object of this class from a read stream.
• TTaskInfo()Default constructor.
• TTaskInfo(TInt,TName &,TInt,TInt)Constructor taking the specified parameters.
• iNameThe name of the task.
• iPriorityThe priority of the task.
• iRepeatSpecifies how often the task is to be repeated.
• iTaskIdThe unique Id for the task.
• operator=(const TTaskInfo &)

See also:

• RScheduler::ScheduleTask(TTaskInfo &,HBufC &,const TInt)Adds a task to an existing persistent schedule.
• RScheduler::GetScheduleL(const TInt,TScheduleState2 &,CArrayFixFlat< TScheduleEntryInfo2 > &,CArrayFixFlat< TTaskInfo > &,TTsTime &)Gets information relating to a specified time based schedule.
• RScheduler::GetTaskInfoL(const TInt,TTaskInfo &,TPtr &,TSchedulerItemRef &,TTsTime &)Gets information relating to a specified task.

Related Topics

 » Symbian OS v9.4 » Examples » System Library example code » Taskschedulerexample: Using Task scheduler for creating and executing tasks

• TaskSchedulerExample: Using Task Scheduler for Creating and Executing Tasks » Class summary

IMPORT_C TTaskInfo(TInt aTaskId, TName &aName, TInt aPriority, TInt aRepeat);

Description

Constructor taking the specified parameters.

Parameters

TInt aTaskId The task Id. TBuf &aName The name of the task. TInt aPriority The task priority. TInt aRepeat How often the task is to be repeated

IMPORT_C TTaskInfo();

Description

Default constructor.

IMPORT_C TTaskInfo& operator=(const TTaskInfo &aTaskInfo);

Description

Parameters

const TTaskInfo &aTaskInfo

Return value

TTaskInfo &

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises an object of this class to a write stream.

The presence of this function means that the standard templated operator<<(RWriteStream &,const T &) can be used to externalise objects of this class.

Parameters

RWriteStream &aStream Stream to which the object should be externalised.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises an object of this class from a read stream.

The presence of this function means that the standard templated operator>>(RReadStream &,T &) 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.

Parameters

RReadStream &aStream Stream from which the object is to be internalised.

TInt iRepeat;

Description

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;

Description

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.

TName iName;

Description

The name of the task.

This is defined by the client.

See also:

• TName...

TInt iPriority;

Description

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.