GetClusterGroupState, fonction (clusapi.h)

Article
02/28/2024

Retourne l’état actuel d’un groupe. Le type PCLUSAPI_GET_CLUSTER_GROUP_STATE définit un pointeur vers cette fonction.

Syntaxe

CLUSTER_GROUP_STATE GetClusterGroupState(
  [in]                HGROUP  hGroup,
  [out, optional]     LPWSTR  lpszNodeName,
  [in, out, optional] LPDWORD lpcchNodeName
);

Paramètres

[in] hGroup

Gérez le groupe pour lequel les informations d’état doivent être retournées.

[out, optional] lpszNodeName

Pointeur vers une chaîne Unicode terminée par un caractère Null contenant le nom du nœud qui possède actuellement le groupe.

[in, out, optional] lpcchNodeName

Pointeur vers la taille de la mémoire tampon lpszNodeName 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

GetClusterGroupState retourne l’état actuel du groupe, qui est représenté par l’une des valeurs suivantes.

Code/valeur de retour	Description
ClusterGroupStateUnknown -1	L’opération n’a pas réussi. Pour plus d’informations sur l’erreur, appelez la fonction GetLastError.
ClusterGroupOnline 0	Toutes les ressources du groupe sont en ligne.
ClusterGroupOffline 1	Toutes les ressources du groupe sont hors connexion ou il n’y a aucune ressource dans le groupe.
ClusterGroupFailed 2	Au moins une ressource du groupe a échoué (définissez l’état ClusterResourceFailed à partir de l’énumération CLUSTER_RESOURCE_STATE ).
ClusterGroupPartialOnline 3	Au moins une ressource du groupe est en ligne. Aucune ressource n’est en attente ou n’a échoué.
ClusterGroupPending 4	Au moins une ressource du groupe est en suspens. Aucune ressource n'a échoué.

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 GetClusterGroupState à partir d’une fonction de point d’entrée DLL de ressource. GetClusterGroupState 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.

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

CLUSTER_GROUP_STATE

CLUSTER_RESOURCE_STATE

Fonctions de gestion de groupe

OpenClusterGroup

Partager via