AccumBrowseOpen
- Last UpdatedOct 28, 2024
- 2 minute read
The AccumBrowseOpen 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
INT AccumBrowseOpen( 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 tagname. 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.
Note: Use the following fields with care in filters since they return the actual value of
the variable tag which they refer to.
RUNNING, STARTS, TOTALISER, TRIGGER, VALUE.
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:
AREA, CLUSTER, EQUIPMENT, ITEM, NAME, PRIV, RUNNING, STARTS, TOTALISER, TRIGGER, VALUE.
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 the 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. After a reload of the Report Server, any new records may be added at the end.
Related Functions
AccumBrowseClose, AccumBrowseFirst, AccumBrowseGetField, AccumBrowseNext, AccumBrowseNumRecords, AccumBrowsePrev
Example
INT iSession;
...
iSession = AccumBrowseOpen("NAME=ABC*", "NAME,AREA",
"ClusterA,ClusterB");
IF iSession <> -1 THEN
// Successful case
ELSE
// Function returned an error
END
...