NCS_NodeNumToName

Specifies the name and number of the node to use in the cluster.

Syntax

 #include <ncssdk.h> 
  
 NCS_RETURN NCS_NodeNumToName (
   NCS_HANDLE   Handle,
   UINT32       NodeNum,
   UINT8       *Name);

Parameters

Handle

(IN) Specifies the current NCS handle.

NodeNum

(IN) Specifies the node number.

Name

(OUT) Points to the name of the node.

Return Values

Name

Description

SUCCESS

NCS_SUCCESS.

NCS_BAD_PARAMETER

See NDS Error Codes.

Remarks

Most of the NCS API functions use a node number for internal management. Use NCS_NodeNumToName to display the name of the node in the user interface.

The input range is 0 - 31. If the node number for the node is not declared in the cluster, the name is New_Nodenumber. The name buffer must be 64 bytes long. Nodes are 0 based.