GetCurrentClusterNodeId macro (clusapi.h)

Returns the unique identifier of the current cluster node.

Syntax

DWORD GetCurrentClusterNodeId(
  [out]      LPWSTR _lpszNodeId,
  [in, out]  LPDWORD _lpcchName_
);

Parameters

[out] _lpszNodeId_

This parameter points to a buffer that receives the unique ID of hNode, including the terminating NULL character.

[in, out] _lpcchName_

On input, pointer to the count of characters in the buffer pointed to by the lpszNodeId parameter, including the NULL terminator. On output, pointer to the count of characters stored in the buffer excluding the NULL terminator.

Return value

Type: DWORD

This function returns a system error code. The following are the possible values:

• ERROR_SUCCESS
  • 0 (0x0)
  • The operation completed successfully.
• ERROR_MORE_DATA
  • 234 (0xEA)
  • More data is available.
  • This value is returned if the buffer pointed to by _lpszNodeId_ is not long enough to hold the required number of characters. GetCurrentClusterNodeId sets the content of _lpcchName_ to the required length.

Remarks

Note that lpcchName refers to a count of characters and not a count of bytes, and that the returned size does not include the terminating NULL in the count. For more information on sizing buffers, see Data size conventions.

Requirements

See also

GetClusterNodeId

Node Management Functions

OpenClusterNode