Class CScheduledTask

class CScheduledTask : public CBase;

Description

The representation of a scheduled task that is passed to registered programs.

When tasks are due, the Task Scheduler encapsulates task information within CScheduledTask objects, and externalises them to a direct file store.

The root stream of the direct file store contains a 32 bit value, followed by the external representations of one or more CScheduledTask objects. The 32 bit value is interpreted as a TInt32 and contains the number of CScheduledTask objects that follow in the stream.

The registered program can create successive CScheduledTask objects from this stream using the static NewLC() function.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CScheduledTask - The representation of a scheduled task that is passed to registered programs

Members

Defined in CScheduledTask:
Data(), Info(), NewLC(), ScheduleType(), SecurityInfo(), ValidUntil()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• TScheduledTaskFile
• RStoreReadStream

static IMPORT_C CScheduledTask *NewLC(RReadStream &aStream);

Description

Creates the object from the specified stream.

Parameters

RReadStream &aStream The stream containing the external representation of this object.

Return value

CScheduledTask * A new instance of a CScheduledTask object.

IMPORT_C const TTaskInfo &Info() const;

Description

Gets the detailed information for the task.

Return value

const TTaskInfo & Detailed information about a task.

IMPORT_C const HBufC &Data() const;

Description

Gets a reference to the data to be passed to the program on execution.

Return value

const HBufC & A reference to the descriptor containing the data.

IMPORT_C const TTsTime &ValidUntil() const;

Description

Gets the time when the task stops being valid.

If the executing program determines that this time is in the past, then it should not run the task.

Return value

const TTsTime & The time when the task stops being valid

IMPORT_C TScheduleType ScheduleType() const;

Description

Gets the schedules type.

Return value

TScheduleType

IMPORT_C const TSecurityInfo &SecurityInfo() const;

Description

Gets the security information for this scheduled task. This information is the securityID, VenforID and capabilities of the client who created the schedule responsible for invoking this task.

Return value

const TSecurityInfo &