Fonction ClusterNetworkEnum (clusapi.h)
Énumère les objets de cluster sur un réseau, en retournant le nom d’un objet à chaque appel. Le type PCLUSAPI_CLUSTER_NETWORK_ENUM définit un pointeur vers cette fonction.
Syntaxe
DWORD ClusterNetworkEnum(
[in] HNETWORKENUM hNetworkEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName
);
Paramètres
[in] hNetworkEnum
Handle à un objet d’énumération existant retourné à l’origine par la fonction ClusterNetworkOpenEnum .
[in] dwIndex
Index utilisé pour identifier l’entrée suivante à énumérer. Ce paramètre doit être égal à zéro pour le premier appel à ClusterNetworkEnum , puis incrémenté pour les appels suivants.
[out] lpdwType
Pointeur vers le type d’objet retourné. La valeur suivante de l’énumération CLUSTER_NETWORK_ENUM est retournée à chaque appel.
CLUSTER_NETWORK_ENUM_NETINTERFACES (1)
L’objet est une interface réseau.
[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. 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 retourne 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 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. |
|
Aucune donnée n'est disponible. Cette valeur est retournée s’il n’y a plus d’objets du type demandé à retourner. |
Remarques
La fonction ClusterNetworkEnum est généralement utilisée pour itérer à travers une collection d’objets d’un ou plusieurs types appartenant à un objet réseau. Si, par exemple, une application souhaite énumérer tous les objets d’interface réseau sur un réseau, elle appelle ClusterNetworkOpenEnum pour ouvrir un énumérateur réseau qui peut traiter des objets d’interface réseau. Le paramètre dwType est défini sur CLUSTER_NETWORK_ENUM_NETINTERFACES pour spécifier les interfaces réseau comme type d’objet à énumérer. Avec le handle retourné par ClusterNetworkOpenEnum , l’application appelle ClusterNetworkEnum à plusieurs reprises pour récupérer chacun des objets. Le paramètre lpdwType pointe vers le type d’objet récupéré.
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.
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 |