SchdSpecialOpen

The SchdSpecialOpen function initiates a new session for browsing the special day groups. It returns a handle for the browsing session which can be used for further browsing operations.

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

Syntax

LONG SchdSpecialOpen(STRING Filter, STRING Fields[, STRING Clusters])

Filter:

A filter expression specifying the records to return during the browse. An empty string indicates that every record will be returned. Multiple filters can be specified and separated with ';'. Where a fieldname is not specified in the filter, it is assumed to be tagname. For example, the filter "AAA" is equivalent to "name=AAA".

Fields:

Specifies via a comma delimited string the columns to be returned during the browse. An empty string indicates that the server will return every available column. Supported fields are:

NAME: The name of the special day group.

ID: The unique ID of the special day group. Every special day group is assigned a unique ID.

Clusters:

An optional parameter that specifies via a comma delimited string the subset of the clusters to browse. An empty string indicates that the connected clusters will be browsed.

Return Value

Returns an integer handle to the browse session. Returns -1 when an error is detected.

Related Functions

SchdSpecialClose, SchdSpecialFirst, SchdSpecialNext, SchdSpecialPrev, SchdSpecialGetField, SchdSpecialNumRecords

See Also

Scheduler Functions