ClusterNodeEnum-Funktion (clusapi.h)

Artikel
02/23/2024

Listet die Netzwerkschnittstellen oder -gruppen auf, die auf einem Knoten installiert sind, und gibt den Namen der Einzelnen mit jedem Aufruf zurück. Der PCLUSAPI_CLUSTER_NODE_ENUM Typ definiert einen Zeiger auf diese Funktion.

Syntax

DWORD ClusterNodeEnum(
  [in]      HNODEENUM hNodeEnum,
  [in]      DWORD     dwIndex,
  [out]     LPDWORD   lpdwType,
  [out]     LPWSTR    lpszName,
  [in, out] LPDWORD   lpcchName
);

Parameter

[in] hNodeEnum

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

[in] dwIndex

Index, der verwendet wird, um den nächsten Eintrag zu identifizieren, der aufgelistet werden soll. Dieser Parameter sollte für den ersten Aufruf von ClusterNodeEnum null und für nachfolgende Aufrufe inkrementiert werden.

[out] lpdwType

Zeiger auf den Typ des zurückgegebenen Objekts. Der folgende Wert der CLUSTER_NODE_ENUM-Enumeration wird bei jedem Aufruf zurückgegeben.

CLUSTER_NODE_ENUM_NETINTERFACES (1)

Das Objekt ist eine Netzwerkschnittstelle.

CLUSTER_NODE_ENUM_GROUPS (0x00000002)

Das Objekt ist eine Clustergruppe.

Windows Server 2008: Der CLUSTER_NODE_ENUM_GROUPS Wert wird vor Windows Server 2008 R2 nicht unterstützt.

[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 als Anzahl von Zeichen. Geben Sie bei der Eingabe die maximale Anzahl von Zeichen an, die der Puffer enthalten kann, einschließlich des beendenden NULL. Gibt bei der Ausgabe die Anzahl der Zeichen im resultierenden Namen an, wobei der beendende NULL-Wert ausgeschlossen wird.

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 des angeforderten Typs 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.

Hinweise

Um ClusterNodeEnum zu verwenden, öffnen Anwendungen zunächst ein Knotenaufzählungshandle, indem sie ClusterNodeOpenEnum aufrufen, wobei der dwType-Parameter auf CLUSTER_NODE_ENUM_NETINTERFACES festgelegt ist. Weitere Informationen finden Sie unter Aufzählung von Objekten.

Beachten Sie, dass der lpcchName-Parameter auf eine Anzahl von Zeichen und nicht auf die Anzahl von Bytes verweist, und dass die zurückgegebene Größe nicht den beendenden NULL in der Anzahl enthält. Weitere Informationen zur Größenanpassung von Puffern finden Sie unter Datengrößenkonventionen.

Beispiele

Weitere Informationen finden Sie unter Auflisten von Objekten.

Anforderungen

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