#include <schinfo.h>
Link against: schsvr.lib
class TScheduleState2 |
Public Member Functions | |
---|---|
TScheduleState2() | |
TScheduleState2(const TScheduleState2 &) | |
TScheduleState2(const TName &, const TTsTime &, TBool, TBool) | |
IMPORT_C const TTsTime & | DueTime() |
IMPORT_C TBool | Enabled() |
IMPORT_C const TName & | Name() |
IMPORT_C TBool | Persists() |
IMPORT_C void | SetDueTime(const TTsTime &) |
IMPORT_C void | SetEnabled(TBool) |
IMPORT_C void | SetName(const TName &) |
IMPORT_C void | SetPersists(TBool) |
IMPORT_C TScheduleState2 & | operator=(const TScheduleState2 &) |
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()
IMPORT_C | TScheduleState2 | ( | ) |
Default Constructor for TScheduleState2. By default, this state: has an empty string name, is non persistent, non enabled and its due time is set to zero.
IMPORT_C | TScheduleState2 | ( | const TScheduleState2 & | aScheduleState | ) |
Copy constructor for TScheduleState2
Parameters | |
---|---|
aScheduleState | The TScheduleState2 object to be copied |
IMPORT_C | TScheduleState2 | ( | const TName & | aName, |
const TTsTime & | aDueTime, | |||
TBool | aPersists, | |||
TBool | aEnabled | |||
) |
Constructor taking the specified parameters.
Parameters | |
---|---|
aName | The name of the schedule |
aDueTime | The time when the schedule is next due. |
aPersists | Boolean to indicate 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 |
aEnabled | Boolean to indicate whether the shedule is enabled or not. |
IMPORT_C TBool | Enabled | ( | ) | const |
Returns information on whether this schedule is enabled or not.
IMPORT_C TBool | Persists | ( | ) | const |
Returns a boolean whether this schedule perists or not.
IMPORT_C void | SetName | ( | const TName & | aName | ) |
Sets the name of the schedule
Parameters | |
---|---|
aName | The name of the schedule |
IMPORT_C void | SetPersists | ( | TBool | aPersists | ) |
Sets a boolean whether this schedule perists or not.
Parameters | |
---|---|
aPersists | Etrue if this schedule persits, EFalse if this schedule doen't persist. |
IMPORT_C TScheduleState2 & | operator= | ( | const TScheduleState2 & | aScheduleState | ) |
Assigns a TScheduleState2 to this object.
See also: Mem::Copy