Fonction ClusterResourceTypeEnum (clusapi.h)

Article
08/22/2023

Énumère les ressources ou nœuds propriétaires possibles d’un type de ressource, en retournant le nom d’un nœud ou d’une ressource par appel. Le type PCLUSAPI_CLUSTER_RESOURCE_TYPE_ENUM définit un pointeur vers cette fonction.

Syntaxe

DWORD ClusterResourceTypeEnum(
  [in]      HRESTYPEENUM hResTypeEnum,
  [in]      DWORD        dwIndex,
  [out]     LPDWORD      lpdwType,
  [out]     LPWSTR       lpszName,
  [in, out] LPDWORD      lpcchName
);

Paramètres

[in] hResTypeEnum

Handle d’énumération de type de ressource retourné par ClusterResourceTypeOpenEnum.

[in] dwIndex

Index de la ressource ou de l’objet de nœud à retourner. Ce paramètre doit être égal à zéro pour le premier appel à ClusterResourceTypeEnum , puis incrémenté pour les appels suivants.

[out] lpdwType

Type d’objet retourné par ClusterResourceTypeEnum. Les valeurs suivantes de l’énumération CLUSTER_RESOURCE_TYPE_ENUM sont valides.

CLUSTER_RESOURCE_TYPE_ENUM_NODES (1)

L’objet est un nœud qui peut être un propriétaire possible du type de ressource.

CLUSTER_RESOURCE_TYPE_ENUM_RESOURCES (2)

L’objet est une ressource qui est une instance du type de ressource.

[out] lpszName

Pointeur vers une chaîne Unicode terminée par null contenant le nom de l’objet retourné.

[in, out] lpcchName

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

La fonction retourne l’une des valeurs suivantes.

Code/valeur de retour	Description
ERROR_SUCCESS 0	L'opération a réussi.
ERROR_NO_MORE_ITEMS 259	Il n’y a plus d’objets à retourner.
ERROR_MORE_DATA 234	La mémoire tampon pointée par lpszName n’est pas assez grande pour contenir le résultat. Le paramètre lpcchName retourne le nombre de caractères dans le résultat, à l’exclusion de la valeur NULL de fin.
Code d’erreur système	L'opération 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.

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