Edit

Share via

GetClusterNetInterface function (clusapi.h)

  • Article

Returns the name of a node's interface to a network in a cluster. The PCLUSAPI_GET_CLUSTER_NET_INTERFACE type defines a pointer to this function.

Syntax

DWORD GetClusterNetInterface(
  [in]      HCLUSTER hCluster,
  [in]      LPCWSTR  lpszNodeName,
  [in]      LPCWSTR  lpszNetworkName,
  [out]     LPWSTR   lpszInterfaceName,
  [in, out] LPDWORD  lpcchInterfaceName
);

Parameters

[in] hCluster

Handle to a cluster.

[in] lpszNodeName

Pointer to a null-terminated Unicode string containing the name of the node in the cluster.

[in] lpszNetworkName

Pointer to a null-terminated Unicode string containing the name of the network.

[out] lpszInterfaceName

Pointer to an output buffer holding the name of the network interface.

[in, out] lpcchInterfaceName

Pointer to the size of the lpszInterfaceName 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 lpszInterfaceName is not big enough to hold the result. The lpcchInterfaceName parameter returns the number of characters in the result, excluding the terminating NULL.

Remarks

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

OpenCluster