TScheduleState2 Class Reference

#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 &)

Detailed Description

Defines the state of a schedule.

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

Constructor & Destructor Documentation

TScheduleState2 ( )

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.

TScheduleState2 ( const TScheduleState2 & )

IMPORT_C

TScheduleState2

(

const TScheduleState2 &

aScheduleState

)

Copy constructor for TScheduleState2

Parameter	Description
aScheduleState	The TScheduleState2 object to be copied

TScheduleState2 ( const TName &, const TTsTime &, TBool, TBool )

IMPORT_C	TScheduleState2	(	const TName &	aName,
			const TTsTime &	aDueTime,
			TBool	aPersists,
			TBool	aEnabled
		)

Constructor taking the specified parameters.

Parameter	Description
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.

Member Function Documentation

DueTime ( )

IMPORT_C const TTsTime &

DueTime

(

)

const

Returns the time when the schedule is next due.

Enabled ( )

IMPORT_C TBool

Enabled

(

)

const

Returns information on whether this schedule is enabled or not.

Returns: Etrue if the schedule is enabled, EFalse id the schedule is not enabled.

Name ( )

IMPORT_C const TName &

Name

(

)

const

Returns: The name of the schedule

Persists ( )

IMPORT_C TBool

Persists

(

)

const

Returns a boolean whether this schedule perists or not.

Returns: Etrue if this schedule persists, EFalse if this schedule doen't persist.

SetDueTime ( const TTsTime & )

IMPORT_C void

SetDueTime

(

const TTsTime &

aDueTime

)

Sets the time when the schedule is next due.

Parameter	Description
aDueTime	The time when the schedule is next due. This time could be either home time (for floating schedules) or UTC time.

SetEnabled ( TBool )

IMPORT_C void

SetEnabled

(

TBool

aEnabled

)

Sets information on whether this schedule is enabled or not.

SetName ( const TName & )

IMPORT_C void

SetName

(

const TName &

aName

)

Sets the name of the schedule

Parameter	Description
aName	The name of the schedule

SetPersists ( TBool )

IMPORT_C void

SetPersists

(

TBool

aPersists

)

Sets a boolean whether this schedule perists or not.

Parameter	Description
aPersists	Etrue if this schedule persits, EFalse if this schedule doen't persist.

operator= ( const TScheduleState2 & )

IMPORT_C TScheduleState2 &

operator=

(

const TScheduleState2 &

aScheduleState

)

Assigns a TScheduleState2 to this object.