Cogent C API and Utilities : Version 6.4
	Cascade DataHub Functions

`DH_SetLock`, `DH_SetSecurity`

DH_SetLock, DH_SetSecurity — set the lock or security according to point status.

Syntax

#include <cogent.h>
ST_STATUS DH_SetLock( IP_Task*   myself, 
  PT_pCPOINT   ppoint, 
  IP_Msg*   hmsg, 
  ER_hLIST   elist);
ST_STATUS DH_SetSecurity( IP_Task*   myself, 
  PT_pCPOINT   ppoint, 
  IP_Msg*   hmsg, 
  ER_hLIST   elist);

Arguments

myself: The task handle associated with this task. This should always be the return value from IP_NserveInit.
ppoint: A pointer to a Cascade DataHub point structure, which must contain at least name. All other fields in the point structure should be 0 if this is the first call on this point, because they will be filled in by this call. Subsequent calls on the same point do not require zeroing any fields. If one point structure is used with several point names, the address field must be zeroed each time a different name is used in a call to this function.
hmsg: A handle to a previously allocated message structure (using IP_MsgCreate) providing enough buffer space to handle the inter-process communication associated with the DataHub transaction.
elist: A return value containing error information. This is unimplemented in this version, and should be NULL.

Returns

ST_OK on success, ST_ERROR on failure, or some other value of ST_STATUS.

Description

These functions set or unset the Cascade DataHub lock or security for a point according to the status of the point itself. They look at the point structure, and set the lock or security status in the DataHub to be the same as the point's locked or security value.

`ST_STATUS DH_SetLock(`	IP_Task*	`myself`,
	PT_pCPOINT	`ppoint`,
	IP_Msg*	`hmsg`,
	ER_hLIST	`elist)`;

`ST_STATUS DH_SetSecurity(`	IP_Task*	`myself`,
	PT_pCPOINT	`ppoint`,
	IP_Msg*	`hmsg`,
	ER_hLIST	`elist)`;


DH_SendPointMessage		DH_SetReceiveFormat

DH_SetLock, DH_SetSecurity

Syntax

Arguments

Returns

Description

`DH_SetLock`, `DH_SetSecurity`