GetClusterNetworkId

The GetClusterNetworkId function returns the identifier of a network.

DWORD WINAPI GetClusterNetworkId(
  HNETWORK hNetwork,                  
  LPWSTR lpszNetworkId,             
  LPDWORD lpcchNetworkId           
);
 

Parameters

hNetwork

[in] Handle to a network.

lpszNetworkId

[out] Pointer to the identifier of the network associated with hNetwork, including the terminating NULL character.

lpcchNetworkId

[in, out] On input, pointer to a buffer. On output, pointer to a count of characters in the network identifier pointed to by lpszNetworkId, including the terminating NULL character.

Return Values

ERROR_SUCCESS

The operation was successful.

ERROR_MORE_DATA

The buffer pointed to by lpszNetworkId is not long enough to hold the required number of characters. The lpcchNetworkId parameter is set to the required buffer length.

If the operation was unsuccessful for a reason other than insufficient size in the buffer pointed to by lpszNetworkId, GetClusterNetworkId returns a Win32 error value.

Remarks

When GetClusterNetworkId returns, the variable pointed to by lpcchNetworkId contains the number of characters stored in the buffer. The count returned does not include the terminating NULL character.

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.