GetClusterResourceState, fonction (clusapi.h)

Article
08/22/2023

Retourne l’état actuel d’une ressource. Le type PCLUSAPI_GET_CLUSTER_RESOURCE_STATE définit un pointeur vers cette fonction.

Syntaxe

CLUSTER_RESOURCE_STATE GetClusterResourceState(
  [in]                HRESOURCE hResource,
  [out, optional]     LPWSTR    lpszNodeName,
  [in, out, optional] LPDWORD   lpcchNodeName,
  [out, optional]     LPWSTR    lpszGroupName,
  [in, out, optional] LPDWORD   lpcchGroupName
);

Paramètres

[in] hResource

Handle spécifiant la ressource pour laquelle les informations d’état doivent être retournées.

[out, optional] lpszNodeName

Pointeur vers une mémoire tampon qui reçoit le nom du nœud propriétaire actuel de la ressource spécifiée en tant que chaîne Unicode terminée par NULL. Transmettez NULL si le nom du nœud n’est pas requis.

[in, out, optional] lpcchNodeName

Pointeur vers la taille de la mémoire tampon lpszNodeName en tant que nombre de caractères. Ce pointeur ne peut pas être NULL , sauf si lpszNodeName a également la valeur NULL. Lors de l’entrée, spécifie 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.

[out, optional] lpszGroupName

Pointeur vers une mémoire tampon qui reçoit le nom du groupe qui contient la ressource spécifiée. Le nom est retourné sous la forme d’une chaîne Unicode terminée par null. Passez la valeur NULL si le nom du groupe n’est pas requis.

[in, out, optional] lpcchGroupName

Pointeur vers la taille de la mémoire tampon lpszGroupName en tant que nombre de caractères. Ce pointeur ne peut pas être NULL , sauf si lpszNodeName a également la valeur NULL. Lors de l’entrée, spécifie 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

GetClusterResourceState retourne l’état actuel de la ressource énumérée à partir de l’énumération CLUSTER_RESOURCE_STATE , qui peut être représentée par l’une des valeurs suivantes.

Code/valeur de retour	Description
ClusterResourceInitializing 1	La ressource effectue l’initialisation.
ClusterResourceOnline 2	La ressource est opérationnelle et fonctionne normalement.
ClusterResourceOffline 3	La ressource n’est pas opérationnelle. Cette valeur est retournée si la ressource a signalé un état ClusterResourceOffline (3) ou ClusterResourceCannotComeOnlineOnThisNode (127).
ClusterResourceFailed 4	La ressource a échoué. Cette valeur est retournée si la ressource a signalé un état ClusterResourceFailed (4) ou ClusterResourceCannotComeOnlineOnAnyNode (126).
ClusterResourcePending 128	La ressource est en cours de mise en ligne ou de mise hors connexion.
ClusterResourceOnlinePending 129	La ressource est en cours de mise en ligne.
ClusterResourceOfflinePending 130	La ressource est en cours de mise hors connexion.
ClusterResourceStateUnknown -1	L’opération n’a pas réussi. Pour plus d’informations sur l’erreur, appelez la fonction GetLastError.

Notes

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

Pour obtenir un exemple, consultez Obtention d’états d’objet.

Spécifications


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