Com return values, 3 events, Brokermap_onallstarted() – Campbell Scientific LoggerNet-SDK Software Development Kit User Manual

Page 81: Name, Description, Brokermap_onbrokeradded(), Brokermap_onbrokerdeleted()

Advertising
background image

Section 16. CsiBrokerMap Control Reference

COM Return Values

Table of Possible Values

Code Meaning

S_OK

Success: Normal return

E_CSI_ALREADY_CONNECTED

Error: Already connected to the
LoggerNet server

E_CSI_BAD_HOST_OR_PORT

Error: Cannot connect. Property
serverName or serverPort possibly
wrong

16.1.3 Events

BrokerMap_onAllStarted()

Name

onAllStarted()

Description

This event is a result of invoking the

start(

) method. This event gets called

after all of the initial

onBrokerAdded()

and

onTableAdded()

events have

been called from the

start()

method and the broker map is known.

BrokerMap_onBrokerAdded()

Name

onBrokerAdded(Object Broker)

Description

This event gets called as new brokers are added to the broker map.
Information about the new broker can be accessed with the broker object
returned with this event.

BrokerMap_onBrokerDeleted()

Name

onBrokerDeleted(Object Broker)

Description

This event gets called as brokers are deleted from the broker map. Information
about the broker deleted from the broker map can be accessed with the broker
object returned with this event. After the broker object returned by this event
goes out of scope, the referenced object in the control will be permanently
deleted. The broker is kept alive for this event so that its properties can be
referenced by the client application one last time.

16-5

Advertising