Cicode Programming Reference > Cicode Function Categories > Server Functions Introduction > ServerBrowseOpen

ServerBrowseOpen

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

Syntax

ServerBrowseOpen(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.

sFields:

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

NAME, TYPE, COMMENT, CLUSTER, MODE, NETADDR, PORT, LEGACYPORT.

See Browse Function Field Reference for information about fields.

sClusters:

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

Return Value

An integer handle to the browse session. Returns -1 on error.

The returned entries will be ordered alphabetically by name.

Related Functions

ServerBrowseClose, ServerBrowseFirst, ServerBrowseGetField, ServerBrowseNext, ServerBrowseNumRecords, ServerBrowsePrev

See Also