ServerBrowseGetField

The ServerBrowseGetField function retrieves the value of the specified field from the record the data browse cursor is currently referencing.

Syntax

ServerBrowseGetField(iSession, sFieldName)

iSession:

Handle to a browse session previously opened by a ServerBrowseOpen call.

sFieldName:

The name of the field that references the value to be returned. Supported fields are:

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

See Browse Function Field Reference for information about fields.

Return Value

The value of the specified field as a string. An empty string may or may not be an indication that an error has been detected. The last error should be checked in this instance to determine if an error has actually occurred.

Related Functions

ServerBrowseClose, ServerBrowseFirst, ServerBrowseNext, ServerBrowseNumRecords, ServerBrowseOpen, ServerBrowsePrev

Example

STRING ServName = ServerBrowseGetField(hServers, "NAME");

See Also

Server Functions