ClusterResourceTypeEnum-Funktion (clusapi.h)

Artikel
02/23/2024

Listet die möglichen Besitzerknoten oder Ressourcen eines Ressourcentyps auf und gibt den Namen eines Knotens oder einer Ressource pro Aufruf zurück. Der PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM Typ definiert einen Zeiger auf diese Funktion.

Syntax

DWORD ClusterResourceTypeEnum(
  [in]      HRESTYPEENUM hResTypeEnum,
  [in]      DWORD        dwIndex,
  [out]     LPDWORD      lpdwType,
  [out]     LPWSTR       lpszName,
  [in, out] LPDWORD      lpcchName
);

Parameter

[in] hResTypeEnum

Von ClusterResourceTypeOpenEnum zurückgegebenes Ressourcentyp-Enumerationshandle.

[in] dwIndex

Index der zurückzugebenden Ressource oder des Knotenobjekts. Dieser Parameter sollte für den ersten Aufruf von ClusterResourceTypeEnum null sein und dann für nachfolgende Aufrufe inkrementiert werden.

[out] lpdwType

Typ des Objekts, das von ClusterResourceTypeEnum zurückgegeben wird. Die folgenden Werte der CLUSTER_RESOURCE_TYPE_ENUM-Enumeration sind gültig.

CLUSTER_RESOURCE_TYPE_ENUM_NODES (1)

Das Objekt ist ein Knoten, der ein möglicher Besitzer des Ressourcentyps sein kann.

CLUSTER_RESOURCE_TYPE_ENUM_RESOURCES (2)

Das -Objekt ist eine Ressource, die eine instance des Ressourcentyps ist.

[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 lpszName-Puffers als Anzahl von Zeichen. Geben Sie bei der Eingabe die maximale Anzahl von Zeichen an, die der Puffer enthalten kann, einschließlich der endenden NULL. Gibt bei der Ausgabe die Anzahl der Zeichen im resultierenden Namen an, wobei der abschließende 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 durchgeführt.
ERROR_NO_MORE_ITEMS 259	Es gibt keine weiteren Objekte, die zurückgegeben werden sollen.
ERROR_MORE_DATA 234	Der Puffer, auf den lpszName verweist, ist nicht groß genug, um das Ergebnis zu halten. Der lpcchName-Parameter gibt die Anzahl der Zeichen im Ergebnis zurück, wobei der beendende NULL-Wert ausgeschlossen wird.
Systemfehlercode	Fehler beim Vorgang.

Hinweise

Beachten Sie, dass lpcchName auf eine Anzahl von Zeichen und nicht auf die Anzahl von Bytes bezieht, und dass die zurückgegebene Größe nicht den abschließenden NULL-Wert 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