Fonction ClusterGroupEnum (clusapi.h)
Énumère les ressources d’un groupe ou les nœuds qui sont les propriétaires préférés d’un groupe, en retournant le nom de la ressource ou du nœud à chaque appel. Le type PCLUSAPI_CLUSTER_GROUP_ENUM définit un pointeur vers cette fonction.
Syntaxe
DWORD ClusterGroupEnum(
[in] HGROUPENUM hGroupEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszResourceName,
[in, out] LPDWORD lpcchName
);
Paramètres
[in] hGroupEnum
Handle d’énumération de groupe retourné par la fonction ClusterGroupOpenEnum .
[in] dwIndex
Index de la ressource ou du nœud à retourner. Ce paramètre doit être égal à zéro pour le premier appel à ClusterGroupEnum , puis incrémenté pour les appels suivants.
[out] lpdwType
Pointeur vers le type d’objet retourné par ClusterGroupEnum. Voici les valeurs valides de l’énumération CLUSTER_GROUP_ENUM .
CLUSTER_GROUP_ENUM_CONTAINS (1)
L’objet est l’une des ressources du groupe.
CLUSTER_GROUP_ENUM_NODES (2)
L’objet est l’un des nœuds de la liste des propriétaires préférés du groupe.
[out] lpszResourceName
Pointeur vers une chaîne Unicode terminée par null contenant le nom de la ressource ou du nœud retourné.
[in, out] lpcchName
Pointeur vers la taille de la mémoire tampon lpszResourceName en tant que nombre de caractères. Lors de l’entrée, spécifiez le nombre maximal de caractères que la mémoire tampon peut contenir, y compris la valeur NULL de fin. Sur la sortie, spécifie le nombre de caractères dans le nom résultant, à l’exclusion de la valeur NULL de fin.
Valeur retournée
La fonction peut retourner l’une des valeurs suivantes.
| Code/valeur de retour | Description |
|---|---|
|
L’opération s’est terminée avec succès. |
|
More data is available. Cette valeur est retournée si la mémoire tampon pointée vers lpszResourceName n’est pas assez grande pour contenir le résultat. Le paramètre lpcchName retourne le nombre de caractères dans le résultat, à l’exclusion de la valeur NULL de fin. |
|
Aucune donnée n'est disponible. Cette valeur est retournée s’il n’y a plus de ressources ou de nœuds à retourner. |
Si l’opération n’a pas réussi en raison d’un problème autre que ceux décrits avec les valeurs ERROR_NO_MORE_ITEMS ou ERROR_MORE_DATA , ClusterGroupEnum retourne un code d’erreur système.
Remarques
Notez que lpcchName fait référence à un nombre de caractères et non à un nombre d’octets, et que la taille retournée n’inclut pas la valeur NULL de fin dans le nombre. Pour plus d’informations sur le dimensionnement des mémoires tampons, consultez Conventions de taille des données.
N’appelez pas ClusterGroupEnum à partir d’une fonction de point d’entrée dll de ressource. ClusterGroupEnum peut être appelé en toute sécurité à partir d’un thread de travail. Pour plus d’informations, consultez Appels de fonction à éviter dans les DLL de ressources.
Exemples
Consultez Énumération d’objets.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Aucun pris en charge |
| Serveur minimal pris en charge | Windows Server 2008 Entreprise, Windows Server 2008 Datacenter |
| Plateforme cible | Windows |
| En-tête | clusapi.h |
| Bibliothèque | ClusAPI.lib |
| DLL | ClusAPI.dll |