ScheduleItemModify

The ScheduleItemModify function modifies an existing schedule.

This function is a blocking function. It blocks the calling Cicode task until the operation is complete.

Syntax

LONG ScheduleItemModify(STRING Cluster, LONG ID, STRING State, TIMESTAMP Start, TIMESTAMP End, STRING Desc)

Cluster:

Name of cluster.

ID:

The unique ID of the schedule within the schedule engine.

State:

The state of the schedule.

Start:

The start time of the schedule. The type of this parameter is TIMESTAMP. Use TimestampCreate or StrToTimestamp to get a TIMESTAMP value.

End:

The end time of the schedule. The type of this parameter is TIMESTAMP. Use TimestampCreate or StrToTimestamp to get a TIMESTAMP value.

Desc

The description of the schedule.

Return Value

Returns 0 if successful otherwise it returns an error.

Related Functions

SchdClose, SchdConfigOpen, SchdConfigClose, SchdConfigFirst, SchdConfigNext, SchdConfigPrev, SchdConfigGetField, SchdConfigNumRecords, SchdOpen, SchdFirst, SchdNext, SchdGetField, SchdNumRecords, ScheduleItemAdd, ScheduleItemSetRepeat, ScheduleItemDelete

See Also

Scheduler Functions