TScheduleState Class Reference

#include <schinfo.h>

Link against: schsvr.lib

class TScheduleState

Detailed Description

Defines the state of a schedule.

An object of this type is passed to, and populated by, a call to RScheduler::GetScheduleL().

See also: RScheduler::GetScheduleL()

Deprecated

and replaced by TScheduleState2.

Member Attribute Documentation

iDueTime

TTime iDueTime

The time when the schedule is next due.

This only has meaning if the schedule is pending, i.e. it is enabled and has tasks associated with it.

iEnabled

TBool iEnabled

Indicates whether the schedule is enabled or not.

iName

TName iName

The name of the schedule.

iPersists

TBool iPersists

Indicates whether the schedule is persistent or not.

If a schedule is persistent, its lifetime is not limited to the lifetime of the tasks associated with it .

If a schedule is transient, it is created together with a new scheduled task, and is destroyed when the task is destroyed.

Constructor & Destructor Documentation

TScheduleState ( const TScheduleState2 & )

TScheduleState(const TScheduleState2 &aScheduleState2)

A constructor for TScheduleState that takes a TScheduleState2 parameter, for use with the deprecated APIs. All TScheduleStates created will have local time based iDueTime data members.

TScheduleState ( )

TScheduleState()[inline]