ClusterGroupEnum-Funktion (clusapi.h)
Listet die Ressourcen in einer Gruppe oder die Knoten auf, die die bevorzugten Besitzer einer Gruppe sind, und gibt bei jedem Aufruf den Namen der Ressource oder des Knotens zurück. Der PCLUSAPI_CLUSTER_GROUP_ENUM-Typ definiert einen Zeiger auf diese Funktion.
Syntax
DWORD ClusterGroupEnum(
[in] HGROUPENUM hGroupEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszResourceName,
[in, out] LPDWORD lpcchName
);
Parameter
[in] hGroupEnum
Ein Von der ClusterGroupOpenEnum-Funktion zurückgegebenes Gruppenaufzählungshandle.
[in] dwIndex
Der Index der zurückzugebenden Ressource oder des Knotens. Dieser Parameter sollte für den ersten Aufruf von ClusterGroupEnum null und für nachfolgende Aufrufe inkrementiert werden.
[out] lpdwType
Ein Zeiger auf den Typ des Von ClusterGroupEnum zurückgegebenen Objekts. Im Folgenden sind gültige Werte der CLUSTER_GROUP_ENUM-Enumeration aufgeführt.
CLUSTER_GROUP_ENUM_CONTAINS (1)
Das -Objekt ist eine der Ressourcen in der Gruppe.
CLUSTER_GROUP_ENUM_NODES (2)
Das -Objekt ist einer der Knoten in der Liste der bevorzugten Besitzer der Gruppe.
[out] lpszResourceName
Ein Zeiger auf eine Unicode-Zeichenfolge mit NULL-Beendigung, die den Namen der zurückgegebenen Ressource oder des zurückgegebenen Knotens enthält.
[in, out] lpcchName
Ein Zeiger auf die Größe des puffers lpszResourceName 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 kann einen der folgenden Werte zurückgeben.
| Rückgabecode/-wert | BESCHREIBUNG |
|---|---|
|
Der Vorgang wurde erfolgreich abgeschlossen. |
|
Weitere Daten sind verfügbar. Dieser Wert wird zurückgegeben, wenn der Puffer, auf den lpszResourceName 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. |
|
Es sind keine weiteren Daten verfügbar. Dieser Wert wird zurückgegeben, wenn keine Ressourcen oder Knoten mehr zurückgegeben werden müssen. |
Wenn der Vorgang aufgrund eines anderen Problems nicht erfolgreich war als das problem, das mit den werten ERROR_NO_MORE_ITEMS oder ERROR_MORE_DATA beschrieben wurde, gibt ClusterGroupEnum einen Systemfehlercode zurück.
Hinweise
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.
Rufen Sie ClusterGroupEnum nicht über eine Ressourcen-DLL-Einstiegspunktfunktion auf. ClusterGroupEnum kann sicher über einen Workerthread aufgerufen werden. Weitere Informationen finden Sie unter Zu vermeidende Funktionsaufrufe in Ressourcen-DLLs.
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 |