ClusterResourceEnum-Funktion (clusapi.h)
Listet die abhängigen Ressourcen, Knoten oder beide einer Ressource auf. Es gibt den Namen eines Clusterobjekts mit jedem Aufruf zurück. Der PCLUSAPI_CLUSTER_RESOURCE_ENUM-Typs definiert einen Zeiger auf diese Funktion.
Syntax
DWORD ClusterResourceEnum(
[in] HRESENUM hResEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName
);
Parameter
[in] hResEnum
Ein Ressourcenaufzählungshandle, das von der ClusterResourceOpenEnum-Funktion zurückgegeben wird.
[in] dwIndex
Der Index der zurückzugebenden Ressource oder des Knotenobjekts. Dieser Parameter sollte für den ersten Aufruf der ClusterResourceEnum-Funktion 0 sein und dann für nachfolgende Aufrufe inkrementiert werden.
[out] lpdwType
Der Typ des von ClusterResourceEnum zurückgegebenen Objekts.
Die möglichen Werte sind einer der folgenden CLUSTER_RESOURCE_ENUM Enumerationswerte:
CLUSTER_RESOURCE_ENUM_DEPENDS (1)
Das Objekt ist eine Ressource, und hResEnum ist eine Ressource, die von diesem Objekt abhängig ist.
CLUSTER_RESOURCE_ENUM_PROVIDES (2)
Das Objekt ist eine Ressource, die von der von hResEnum identifizierten Ressource abhängt.
CLUSTER_RESOURCE_ENUM_NODES (4)
Das Objekt ist ein Knoten, der die von hResEnum identifizierte Ressource hosten kann.
[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-Zeichens. Gibt bei der Ausgabe die Anzahl der Zeichen im resultierenden Namen an, wobei das endende NULL-Zeichen ausgeschlossen wird.
Rückgabewert
Die Funktion gibt einen der folgenden Werte zurück.
| Rückgabecode/-wert | BESCHREIBUNG |
|---|---|
|
Der Vorgang wurde erfolgreich abgeschlossen, oder der lpszName-Parameter ist NULL. |
|
Der Puffer, auf den der parameter lpszName verweist, ist nicht groß genug, um das Ergebnis zu halten. Der Parameter lpcchName gibt die Anzahl der Zeichen im Ergebnis zurück, wobei das beendende NULL-Zeichen ausgeschlossen wird. |
|
Es gibt keine weiteren Objekte, die zurückgegeben werden müssen. |
| Jeder andere zurückgegebene Fehlercode gibt an, dass der Vorgang fehlgeschlagen ist. |
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 das beendende NULL-Zeichen in der Anzahl enthält. Weitere Informationen zur Größenanpassung von Puffern finden Sie unter Datengrößenkonventionen.
Rufen Sie ClusterResourceEnum nicht über eine Ressourcen-DLL-Einstiegspunktfunktion auf. ClusterResourceEnum kann sicher von einem 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 |