setPointLock

setPointLock — sets the lock attributes of a Cascade DataHub point.

Syntax

For C++:

ST_STATUS setPointLock(CDataHubPoint&  point,
 bool  locked);
ST_STATUS setPointLock(LPCTSTR  pointname,
 bool  locked);

For Java:

Exception setPointLock(DataHubPoint  point,
 boolean  locked);
Exception setPointLock(String  pointname,
 boolean  locked);

For C#:

Exception setPointLock(DataHubPoint  point,
 bool  locked);
Exception setPointLock(String  pointname,
 bool  locked);

Parameters

point

A DataHubPoint object. The name and security members must be valid.

pointname

The name of the point.

locked

If TRUE, the point will have its locked attribute set, otherwise the locked attribute is cleared.

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 sets the lock attributes of a Cascade DataHub point.

See Also

setPointSecurity