Cicode Programming Reference > Cicode Function Categories > Trend Functions Introduction > TrnBrowseOpen

TrnBrowseOpen

The TrnBrowseOpen 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

TrnBrowseOpen( sFilter, sFields [, sClusters] )

sFilter

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".

sFields

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:

ACQERROR, AREA, EXPRESSION, FILENAME, FILES, FORMAT, LSL, PERIOD, PRIV, RANGE, SDEVIATION, SPCFLAG, STORMETHOD, SUBGRPSIZE, TAGGENLINK, TIME, TRIGGER, USL, XDOUBLEBAR.

See Browse Function Field Reference for information about fields.

sClusters

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 on error.

The returned entries will be ordered alphabetically by name.

Related Functions

TrnBrowseClose, TrnBrowseFirst, TrnBrowseGetField, TrnBrowseNext, TrnBrowseNumRecords, TrnBrowsePrev

Example

INT iSession;
...
iSession = TrnBrowseOpen("NAME=ABC*", "NAME,TYPE", "ClusterA,ClusterB");
IF iSession <> -1 THEN
// Successful case
ELSE
// Function did not succeed
END
...

See Also

Trend Functions