ClusterNetInterfaceEnum-Funktion (clusapi.h)

Artikel
02/26/2024

Listet die Netzwerkschnittstellen auf, die in einem Cluster installiert sind, und gibt bei jedem Aufruf einen Namen zurück.

Syntax

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

Parameter

[in] hNetInterfaceEnum

Behandeln Sie ein vorhandenes Enumerationsobjekt, das ursprünglich von der ClusterNetInterfaceOpenEnum-Funktion zurückgegeben wurde.

[in] dwIndex

Index, der zum Identifizieren des aufzuzählenden Eintrags verwendet wird. Dieser Parameter sollte für den ersten Aufruf 0 sein und dann für jeden nachfolgenden Aufruf inkrementiert werden.

[out] lpszName

Zeiger auf eine mit NULL beendete Unicode-Zeichenfolge, die den Namen des zurückgegebenen Objekts enthält.

[in, out] lpcchName

Zeiger auf die Größe des Puffers lpszName in Zeichen. Geben Sie bei der Eingabe die maximale Anzahl von Zeichen an, die der Puffer enthalten kann, einschließlich des beendenden NULL. Gibt in der Ausgabe die Anzahl der Zeichen im resultierenden Namen an, wobei der beendende NULL-Wert ausgeschlossen ist.

Rückgabewert

Die Funktion gibt einen der folgenden Werte zurück.

Rückgabecode/-wert	BESCHREIBUNG
ERROR_SUCCESS 0	Der Vorgang wurde erfolgreich abgeschlossen.
ERROR_NO_MORE_ITEMS 259 (0x103)	Es sind keine weiteren Daten verfügbar. Dieser Wert wird zurückgegeben, wenn keine weiteren Objekte zurückgegeben werden sollen.
ERROR_MORE_DATA 234 (0xEA)	Weitere Daten sind verfügbar. Dieser Wert wird zurückgegeben, wenn der Puffer, auf den lpszName verweist, nicht groß genug ist, um das Ergebnis zu halten. Der Parameter lpcchName gibt die Anzahl der Zeichen im Ergebnis zurück, wobei das beendende NULL ausgeschlossen wird.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows Server 2016
Zielplattform	Windows
Kopfzeile	clusapi.h
Bibliothek	ClusAPI.lib
DLL	ClusAPI.dll

Freigeben über