ClusterNetworkEnum-Funktion (clusapi.h)

Artikel
08/22/2023

Listet Clusterobjekte in einem Netzwerk auf und gibt mit jedem Aufruf den Namen eines Objekts zurück. Der PCLUSAPI_CLUSTER_NETWORK_ENUM Typ definiert einen Zeiger auf diese Funktion.

Syntax

DWORD ClusterNetworkEnum(
  [in]      HNETWORKENUM hNetworkEnum,
  [in]      DWORD        dwIndex,
  [out]     LPDWORD      lpdwType,
  [out]     LPWSTR       lpszName,
  [in, out] LPDWORD      lpcchName
);

Parameter

[in] hNetworkEnum

Ein Handle für ein vorhandenes Enumerationsobjekt, das ursprünglich von der ClusterNetworkOpenEnum-Funktion zurückgegeben wurde.

[in] dwIndex

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

[out] lpdwType

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

CLUSTER_NETWORK_ENUM_NETINTERFACES (1)

Das Objekt ist eine Netzwerkschnittstelle.

[out] lpszName

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

[in, out] lpcchName

Ein Zeiger auf die Größe des lpszName-Puffers 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_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.
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.

Hinweise

Die ClusterNetworkEnum-Funktion wird in der Regel verwendet, um eine Auflistung von Objekten eines oder mehrerer Typen zu durchlaufen, die zu einem Netzwerkobjekt gehören. Wenn eine Anwendung beispielsweise alle Netzwerkschnittstellenobjekte in einem Netzwerk auflisten möchte, ruft sie ClusterNetworkOpenEnum auf, um einen Netzwerkumerator zu öffnen, der Netzwerkschnittstellenobjekte verarbeiten kann. Der dwType-Parameter ist auf CLUSTER_NETWORK_ENUM_NETINTERFACES festgelegt, um Netzwerkschnittstellen als Aufzählungsobjekttyp anzugeben. Mit dem Von ClusterNetworkOpenEnum zurückgegebenen Handle ruft die Anwendung Wiederholt ClusterNetworkEnum auf, um jedes der Objekte abzurufen. Der lpdwType-Parameter zeigt auf den Typ des abgerufenen Objekts.

Beachten Sie, dass lpcchName 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