NCS_Lock (Obsolete 10/5/2005)

Acquired a distributed lock as specified by applications within the cluster but is now obsolete.

Syntax

 #include <ncssdk.h> 
  
 NCS_RETURN NCS_Lock (
   NCS_HANDLE   Handle, 
   NCS_KEY      Key, 
   UINT32       KeyLen);

Parameters

Handle

(IN) Specifies the handle supplied by NCS.

Key

(IN) Specifies the lock key; maximum of 32 bytes.

KeyLen

(IN) Specifies the lock key length.

Return Values

The following table lists possible return values, descriptions and lock errors:

Name

Description

SUCCESS

NCS_SUCCESS.

FAILURE

Remarks

NCS_Lock is used for distributed cluster locking mechanisms.