Fonction ClusterNodeEnum (clusapi.h)
Énumère les interfaces réseau ou les groupes installés sur un nœud, en retournant le nom de chacun à chaque appel. Le type PCLUSAPI_CLUSTER_NODE_ENUM définit un pointeur vers cette fonction.
Syntaxe
DWORD ClusterNodeEnum(
[in] HNODEENUM hNodeEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName
);
Paramètres
[in] hNodeEnum
Gérez un objet d’énumération existant retourné à l’origine par la fonction ClusterNodeOpenEnum .
[in] dwIndex
Index utilisé pour identifier l’entrée suivante à énumérer. Ce paramètre doit être égal à zéro pour le premier appel à ClusterNodeEnum , puis incrémenté pour les appels suivants.
[out] lpdwType
Pointeur vers le type d’objet retourné. La valeur suivante de l’énumération CLUSTER_NODE_ENUM est retournée à chaque appel.
CLUSTER_NODE_ENUM_NETINTERFACES (1)
L’objet est une interface réseau.
CLUSTER_NODE_ENUM_GROUPS (0x00000002)
L’objet est un groupe de clusters.
Windows Server 2008 : La valeur CLUSTER_NODE_ENUM_GROUPS n’est pas prise en charge avant Windows Server 2008 R2.
[out] lpszName
Pointeur vers une chaîne Unicode terminée par null contenant le nom de l’objet retourné.
[in, out] lpcchName
Pointeur vers la taille de la mémoire tampon lpszName 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. Lors de 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 retourne l’une des valeurs suivantes.
| Code/valeur de retour | Description |
|---|---|
|
L’opération s’est terminée avec succès. |
|
Aucune donnée n'est disponible. Cette valeur est retournée s’il n’y a plus d’objets du type demandé à retourner. |
|
More data is available. Cette valeur est retournée si la mémoire tampon pointée par lpszName 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. |
Remarques
Pour utiliser ClusterNodeEnum, les applications ouvrent d’abord un handle d’énumération de nœud en appelant ClusterNodeOpenEnum avec le paramètre dwType défini sur CLUSTER_NODE_ENUM_NETINTERFACES. Pour plus d’informations, consultez Énumération d’objets.
Notez que le paramètre 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.
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 |