Com return values, 2 methods, Brokermap.brokers() – Campbell Scientific LoggerNet Server SDK User Manual

Page 80: Name, Description, Brokermap.finish(), Brokermap.start()

Advertising
background image

Section 16. CsiBrokerMap Control Reference

COM Return Values

Table of Possible Values

Code Meaning

S_OK Success:

Normal

Return

16.1.2 Methods

BrokerMap.Brokers()

Name

BrokerMap.Brokers() As Object

Description

Use this method to iterate through the Brokers and return a Broker Collection.

BrokerMap.finish()

Name

BrokerMap.finish()

Description

This method tells the control to discontinue sending events or changes to the
brokers, which holds the current broker map in a static format for your
application. This method should only be called after the start() method has
been invoked.

COM Return Values

Table of Possible Values

Code Meaning

S_OK

Success: Normal return.

BrokerMap.start()

Name

BrokerMap.start()

Description

This method starts the broker map query to get the brokers, tables, and
columns. Immediately following the invocation of this method, the events

onBrokerAdded()

and

onTableAdded()

will follow to describe the brokers

and tables currently in the broker map.

If there is already a connection to the server, this method will return the error

E_CSI_ALREADY_CONNECTED

. If an error occurs while trying to connect, this

method will return the error

E_CSI_BAD_HOST_OR_PORT

.

16-4

Advertising