SchdSpecialItemOpen

This function initiates a new session for browsing the special days. 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 SchdSpecialItemOpen(STRING Filter, STRING Fields [, STRING Clusters])

Filter:

A filter expression specifying the records to return during the browse. An empty string indicates that all records will be returned.

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. See SchdSpecialItemGetField for the fields supported.

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

SchdSpecialItemFirst, SchdSpecialItemClose, SchdSpecialItemNext, SchdSpecialItemPrev, SchdSpecialItemGetField, SchdSpecialItemNumRecords

See Also

Scheduler Functions