unregisterPoint
unregisterPoint — stops receiving updates from a DataHub point.
ST_STATUS unregisterPoint( | point); |
CDataHubPoint& point;ST_STATUS unregisterPoint( | pointname); |
LPCTSTR pointname;Exception unregisterPoint( | point); |
DataHubPoint point;Exception unregisterPoint( | pointname); |
String pointname;pointA
DataHubPoint object. The name
member must be valid.
pointnameThe name of the point.
ST_OK if the command was successfully sent to the
DataHub instance. Since the command is sent asynchronously, the actual
success or failure of the command must be determined through the onSuccess
or onError message handlers.
ST_NO_TASK if a connection to the DataHub instance
does not exist.
ST_ERROR if the connection socket is unable to
send the message.
This method stops changes to the specified DataHub point from invoking the onPointChange
method. If the DataHub point does not exist, then the DataHub instance will respond
with an error, and onError will be called
with the following arguments:
status: ST_NO_POINT |
msg: "Point does not exist" |