Fonction ClusterOpenEnum (clusapi.h)

Article
08/22/2023

Ouvre un énumérateur pour l’itération au sein d’objets de cluster dans un cluster. Le type PCLUSAPI_CLUSTER_OPEN_ENUM définit un pointeur vers cette fonction.

Syntaxe

HCLUSENUM ClusterOpenEnum(
  [in] HCLUSTER hCluster,
  [in] DWORD    dwType
);

Paramètres

[in] hCluster

Handle pour un cluster.

[in] dwType

Masque de bits qui décrit le type d’objets à énumérer. Une ou plusieurs des valeurs suivantes de l’énumération CLUSTER_ENUM sont valides.

CLUSTER_ENUM_NODE (1 (0x1))

Énumère les nœuds du cluster.

CLUSTER_ENUM_RESTYPE (2 (0x2))

Énumère les types de ressources dans le cluster.

CLUSTER_ENUM_RESOURCE (4 (0x4))

Énumère les ressources dans le cluster.

CLUSTER_ENUM_GROUP (8 (0x8))

Énumère les groupes dans le cluster.

CLUSTER_ENUM_NETWORK (16 (0x10))

Énumère les réseaux dans le cluster.

CLUSTER_ENUM_NETINTERFACE (32 (0x20))

Énumère les interfaces réseau dans le cluster.

CLUSTER_ENUM_SHARED_VOLUME_RESOURCE (1073741824 (0x40000000))

Énumère les volumes partagés de cluster utilisés par le cluster.

Note Contrairement à la plupart des autres masque de bits d’énumération, cette valeur doit être utilisée seule. N’utilisez pas l’opérateur OR pour le combiner avec d’autres masque de bits.

Windows Server 2008 : La valeur CLUSTER_ENUM_SHARED_VOLUME_RESOURCE n’est pas prise en charge avant Windows Server 2008 R2.

CLUSTER_ENUM_INTERNAL_NETWORK (2147483648 (0x80000000))

Énumère les réseaux utilisés par le cluster pour la communication interne. Les réseaux sont énumérés dans l’ordre de priorité la plus élevée à la plus faible, comme établi par SetClusterNetworkPriorityOrder.

CLUSTER_ENUM_ALL ((CLUSTER_ENUM_NODE | CLUSTER_ENUM_RESTYPE | CLUSTER_ENUM_RESOURCE | CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NETWORK | CLUSTER_ENUM_NETINTERFACE))

Énumère tous les objets de cluster.

Valeur retournée

Si l’opération réussit, ClusterOpenEnum retourne un handle à un énumérateur de cluster.

Si l’opération échoue, la fonction retourne NULL. Pour plus d’informations sur l’erreur, appelez la fonction GetLastError.

Remarques

Les applications appellent la fonction ClusterOpenEnum pour créer un type particulier d’énumérateur. ClusterOpenEnum peut créer des énumérateurs pour l’itération au sein de groupes, de nœuds, de types de ressources, de ressources ou de tous ces éléments. Par exemple, une application peut appeler ClusterOpenEnum pour obtenir une énumération de tous les nœuds et groupes d’un cluster en spécifiant CLUSTER_ENUM_GROUP | CLUSTER_ENUM_NODE dans le paramètre dwType . ClusterOpenEnum retourne un handle qui peut être passé à ClusterEnum pour accéder à chacun des groupes ou nœuds de cluster et à ClusterCloseEnum pour libérer l’énumérateur.

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

Voir aussi

Fonctions de gestion de cluster

ClusterCloseEnum

ClusterEnum

SetClusterNetworkPriorityOrder

Partager via