NCS_ClusterName

Provides that cluster name in cBuff and the maximum size allowed in buf_len.

Syntax

 
 
 #include <ncssdk.h> 
  
 NCS_RETURN NCS_ClusterName (
    NCS_HANDLE   Handle,  
    UINT8       *cBuff,   
    UINT32      *buf_len);
 

Parameters

Handle

(IN) Specifies the handle supplied by NCS.

cBuff

(OUT) Points to the node’s cluster name in the buffer.

buf_len

(IN/OUT) Points to the maximum allowable size of the buffer.

Return Values

Name

Description

NCS_SUCCESS

Cluster okay.

NCS_BAD_PARAMETER

Buffer too small.

Remarks

As this function performs a loop, parameter data is copied into the buffer.