GetClusterNetworkId function (clusapi.h)

  • Article

Returns the identifier of a network. The PCLUSAPI_GET_CLUSTER_NETWORK_ID type defines a pointer to this function.

Syntax

DWORD GetClusterNetworkId(
  [in]      HNETWORK hNetwork,
  [out]     LPWSTR   lpszNetworkId,
  [in, out] LPDWORD  lpcchName
);

Parameters

[in] hNetwork

Handle to a network.

[out] lpszNetworkId

Pointer to the identifier of the network associated with hNetwork, including the null-terminating character.

[in, out] lpcchName

Pointer to the size of the lpszNetworkID buffer as a count of characters. On input, specify the maximum number of characters the buffer can hold, including the terminating NULL. On output, specifies the number of characters in the resulting name, excluding the terminating NULL.

Return value

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code. The following is one of the possible values.

Return code Description
ERROR_MORE_DATA
 The buffer pointed to by lpszNetworkID is not big enough to hold the result. The lpcchNetworkID parameter returns the number of characters in the result, excluding the terminating NULL.

Remarks

Note that lpcchNetworkID 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

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform Windows
Header clusapi.h
Library ClusAPI.lib
DLL ClusAPI.dll

See also

OpenClusterNetwork