EquipBrowseOpen

The EquipBrowseOpen function initiates a new browse session and returns a handle to the new session that can be used in subsequent data browse function calls.

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

Syntax

LONG EquipBrowseOpen(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. Where a fieldname is not specified in the filter, it is assumed to be equipment name. For example, the filter "AAA" is equivalent to "name=AAA".

The following regular expressions are supported: *expr, expr*, and *expr*. To specify an exclusion filtering condition, use the NOT keyword after the = operator.

Fields:

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

ALIAS, AREA, CLUSTER, COMMENT, CONTENT, CUSTOM1...8, DEFSTATE, DEVSCHED, HIDDEN, LOCATION, NAME, PAGE, PARAM, PARENT, SCHEDID, SCHEDULED, TAGPREFIX, TYPE.

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 all connected clusters will be browsed.

Return Value

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

The returned entries will be ordered alphabetically by name.

Related Functions

EquipBrowseClose, EquipBrowseFirst, EquipBrowseGetField, EquipBrowseNext, EquipBrowseNumRecords, EquipBrowsePrev, EquipCheckUpdate, EquipGetProperty

Example

INT iSession;
...
iSession = EquipBrowseOpen("NAME=ABC*", "NAME,AREA",

"ClusterA,ClusterB");

IF iSession <> -1 THEN

// Successful case

ELSE

// Function returned an error

END
...

See Also

Equipment Database Functions