GetClusterInformation, fonction (clusapi.h)

Article
02/26/2024

Récupère le nom et la version d’un cluster . Le type PCLUSAPI_GET_CLUSTER_INFORMATION définit un pointeur vers cette fonction.

Syntaxe

DWORD GetClusterInformation(
  [in]            HCLUSTER             hCluster,
  [out]           LPWSTR               lpszClusterName,
  [in, out]       LPDWORD              lpcchClusterName,
  [out, optional] LPCLUSTERVERSIONINFO lpClusterInfo
);

Paramètres

[in] hCluster

Gérer vers un cluster.

[out] lpszClusterName

Pointeur vers une chaîne Unicode terminée par null contenant le nom du cluster identifié par hCluster.

[in, out] lpcchClusterName

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

[out, optional] lpClusterInfo

Null ou pointeur vers une structure CLUSTERVERSIONINFO décrivant la version du service cluster. Lorsque lpClusterInfo n’a pas la valeur NULL, le membre dwVersionInfoSize de cette structure doit être défini comme suit : lpClusterInfo->dwVersionInfoSize = sizeof(CLUSTERVERSIONINFO);

Valeur retournée

Si l’opération réussit, la fonction retourne ERROR_SUCCESS (0).

Si l’opération échoue, la fonction retourne un code d’erreur système. Voici l’une des valeurs possibles.

Code de retour	Description
ERROR_MORE_DATA	La mémoire tampon pointée vers lpszClusterName n’est pas assez grande pour contenir le résultat. Le paramètre lpcchClusterName retourne le nombre de caractères dans le résultat, à l’exclusion de la valeur NULL de fin.

Remarques

Notez que lpcchClusterName 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

Voir aussi

CLUSTERVERSIONINFO

Partager via