SchdSpecialItemModifyRange

The SchdSpecialItemModifyRange function can be used to modify a range of special days in a specified special day group (category).

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

Syntax

INT SchdSpecialItemAddRange(STRING Cluster, STRING GroupID, TIMESTAMP FirstDay, TIMESTAMP LastDay, STRING NewName, TIMESTAMP NewFirstDay, TIMESTAMP NewLastDay)

Cluster:

The name of the cluster.

GroupID:

The ID of the special day group.

FirstDay:

The first day of the special day range as a timestamp. Use TimestampCreate or StrToTimestamp Cicode functions to get a timestamp data value. When creating a timestamp, please use midnight of the required day.

LastDay:

Last day (inclusive) of the special day range as a timestamp. Use TimestampCreate or StrToTimestamp Cicode functions to get a timestamp data value. When creating a timestamp, please use midnight of the required day.

NewName:

A new name for the special days.

NewFirstDay:

A new first day for the special day range as a timestamp. Use TimestampCreate or StrToTimestamp Cicode functions to get a timestamp data value. When creating a timestamp, please use midnight of the required day.

NewLastDay:

A new last day (inclusive) of the special day range as a timestamp. Use TimestampCreate or StrToTimestamp Cicode functions to get a timestamp data value. When creating a timestamp, please use midnight of the required day.

Return Value

0 if successful, otherwise an error code is returned.

Related Functions

SchdSpecialItemAddRange, SchdSpecialItemDeleteRange

Example

// Modify the existing special day range for group id 1
// from 2018-05-06 : 2018-05-10
// to 2018-06-06 : 2018-06-10

SchdSpecialItemModifyRange("Cluster1", 1, "NewDays",
TimestampCreate(2018,5,6,0,0,0,0,0), TimestampCreate(2018,5,10,0,0,0,0,0),
TimestampCreate(2018,6,6,0,0,0,0,0), TimestampCreate(2018,6,10,0,0,0,0,0));

See Also

Scheduler Functions