EquipStateBrowseOpen

The EquipStateBrowseOpen function initiates a new session for browsing the equipment states configured. 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 EquipStateBrowseOpen(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. Where a field name 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. Available fields are:

CLUSTER, DELAY, DRMODE, EQUIPMENT, NAME, PERIOD, PRESTATE, PRIORITY.

See Browse Function Field Reference for information about fields.

Clusters:

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

Return Value

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

Related Functions

EquipStateBrowseClose, EquipStateBrowseFirst, EquipStateBrowseGetField, EquipStateBrowseNext, EquipStateBrowseNumRecords, EquipStateBrowsePrev, EquipGetProperty

See Also

Equipment Database Functions