Edit

Share via

ClusterNetInterfaceEnum function (clusapi.h)

  • Article

Enumerates the network interfaces installed on a cluster, returning one name with each call.

Syntax

DWORD ClusterNetInterfaceEnum(
  [in]      HNETINTERFACEENUM hNetInterfaceEnum,
  [in]      DWORD             dwIndex,
  [out]     LPWSTR            lpszName,
  [in, out] LPDWORD           lpcchName
);

Parameters

[in] hNetInterfaceEnum

Handle to an existing enumeration object originally returned by the ClusterNetInterfaceOpenEnum function.

[in] dwIndex

Index used to identify the entry to be enumerated. This parameter should be zero for the first call and then incremented for each subsequent call.

[out] lpszName

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

[in, out] lpcchName

Pointer to the size, in characters, of the lpszName buffer. On input, specify the maximum number of characters the buffer can hold, including the terminating NULL. On output, indicates the number of characters in the resulting name, excluding the terminating NULL.

Return value

The function returns one of the following values.

Return code/value Description
ERROR_SUCCESS
0
 The operation completed successfully.
ERROR_NO_MORE_ITEMS
259 (0x103)
 No more data is available. This value is returned if there are no more objects to be returned.
ERROR_MORE_DATA
234 (0xEA)
 More data is available. This value is returned if the buffer pointed to by lpszName is not big enough to hold the result. The lpcchName parameter returns the number of characters in the result, excluding the terminating NULL.

Requirements

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