GetClusterNodeId, fonction (clusapi.h)
Retourne l’identificateur unique d’un nœud de cluster. Le type PCLUSAPI_GET_CLUSTER_NODE_ID définit un pointeur vers cette fonction.
Syntaxe
DWORD GetClusterNodeId(
[in, optional] HNODE hNode,
[out] LPWSTR lpszNodeId,
[in, out] LPDWORD lpcchName
);
Paramètres
[in, optional] hNode
Gérez le nœud avec l’identificateur à retourner ou NULL. Si hNode a la valeur NULL, l’identificateur du nœud sur lequel l’application s’exécute est retourné dans le contenu de lpszNodeId.
[out] lpszNodeId
Ce paramètre pointe vers une mémoire tampon qui reçoit l’ID unique de hNode, y compris le caractère NULL de fin.
[in, out] lpcchName
Lors de l’entrée, pointeur vers le nombre de caractères dans la mémoire tampon vers lequel pointe le paramètre lpszNodeId , y compris le terminateur NULL . Lors de la sortie, pointeur vers le nombre de caractères stockés dans la mémoire tampon, à l’exception de la marque de fin NULL .
Valeur retournée
Cette fonction retourne un code d’erreur système. Les valeurs possibles sont les 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 par lpszNodeId n’est pas suffisamment longue pour contenir le nombre de caractères requis. GetClusterNodeId définit le contenu de lpcchName sur la longueur requise. |
Remarques
Le type PCLUSAPI_GET_CLUSTER_NODE_ID définit un pointeur vers cette fonction.
Si hNode a la valeur NULL et que l’appelant s’exécute sur un nœud de cluster actif, la fonction GetClusterNodeId retourne l’identificateur du nœud sur lequel l’application s’exécute. L’affectation de la valeur NULL à hNode est un moyen pratique pour les DLL de ressources de déterminer l’identificateur de nœud du nœud sur lequel elles s’exécutent. La macro GetCurrentClusterNodeId peut être utilisée au lieu de transmettre la valeur NULL pour le paramètre hNode .
Un identificateur de nœud de cluster est un identificateur unique qui ne change pas même si le nom du nœud est modifié.
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.
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 |