Com return values, Brokermap.autoexpand, Name – Campbell Scientific LoggerNet Server SDK User Manual

Page 79: Description, Default value, Brokermap.serverconnected

Advertising
background image

Section 16. CsiBrokerMap Control Reference

COM Return Values

Table of Possible Values

Code Meaning

S_OK

Success: Normal return

E_CSI_BUSY

Error: Attempt to set serverPort while connected
to the LoggerNet server

E_CSI_INVALIDARG Error: The port value is invalid (out of range)

BrokerMap.autoExpand

Name

BrokerMap.autoExpand As Boolean

Description

This setting determines if the broker will automatically expand to include all
brokers and tables or if the Broker.start_expansion() method must be called to
list all the brokers and Table.start_expansion() method to list all tables for each
broker. If the list of brokers and tables is extensive, it may be quicker to list
the brokers and expand the tables for each broker separately. The default
setting is true, which means that all brokers and tables will be expanded
automatically.

Default Value

The default value for this property is true

COM Return Values

Table of Possible Values

Code Meaning

S_OK Success:

Normal

return

BrokerMap.serverConnected

Name

BrokerMap.serverConnected As Boolean

Description

This property describes the state of the connection between the BrokerMap
control and the LoggerNet server. If the connection is active, the property is
TRUE. Otherwise, the property is FALSE.

16-3

Advertising