Fonction ClusterResourceEnum (clusapi.h)
Énumère les ressources dépendantes d’une ressource , les nœuds ou les deux. Il retourne le nom d’un objet de cluster à chaque appel. Le type PCLUSAPI_CLUSTER_RESOURCE_ENUM définit un pointeur vers cette fonction.
Syntaxe
DWORD ClusterResourceEnum(
[in] HRESENUM hResEnum,
[in] DWORD dwIndex,
[out] LPDWORD lpdwType,
[out] LPWSTR lpszName,
[in, out] LPDWORD lpcchName
);
Paramètres
[in] hResEnum
Handle d’énumération de ressources retourné par la fonction ClusterResourceOpenEnum .
[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 à la fonction ClusterResourceEnum , puis incrémenté pour les appels suivants.
[out] lpdwType
Type d’objet retourné par ClusterResourceEnum.
Les valeurs possibles sont l’une des valeurs d’énumération CLUSTER_RESOURCE_ENUM suivantes :
CLUSTER_RESOURCE_ENUM_DEPENDS (1)
L’objet est une ressource et hResEnum est une ressource qui dépend de cet objet.
CLUSTER_RESOURCE_ENUM_PROVIDES (2)
L’objet est une ressource qui dépend de la ressource identifiée par hResEnum.
CLUSTER_RESOURCE_ENUM_NODES (4)
L’objet est un nœud qui peut héberger la ressource identifiée par hResEnum.
[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 le caractère null de fin. Sur la sortie, spécifie le nombre de caractères dans le nom résultant, à l’exclusion du caractère null de fin.
Valeur retournée
La fonction retourne l’une des valeurs suivantes.
| Code/valeur de retour | Description |
|---|---|
|
L’opération s’est terminée correctement ou le paramètre lpszName a la valeur NULL. |
|
La mémoire tampon pointée vers le paramètre 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 du caractère null de fin. |
|
Il n’y a plus d’objets à retourner. |
| Tout autre code d’erreur retourné indique que 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 le caractère 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 ClusterResourceEnum à partir d’une fonction de point d’entrée dll de ressource. ClusterResourceEnum 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
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 |