unregisterPoint

unregisterPoint — stops receiving updates from a Cascade DataHub point.

Syntax

For C++:

ST_STATUS unregisterPoint(CDataHubPoint&  point);
ST_STATUS unregisterPoint(LPCTSTR  pointname);

For Java and C#:

Exception unregisterPoint(DataHubPoint  point);
Exception unregisterPoint(String  pointname);

Parameters

point

A DataHubPoint object. The name member must be valid.

pointname

The name of the point.

Returns

For C++:

    ST_OK if the command was successfully sent to the DataHub. 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 does not exist.

    ST_ERROR if the connection socket is unable to send the message.

Description

This method stops changes to the specified DataHub point from invoking the onPointChange method. If the DataHub point does not exist, then the DataHub will respond with an error, and onError will be called with the following arguments:

status: ST_NO_POINT
msg: "Point does not exist"

See Also

writePoint, registerPoint