Fonction ResUtilEnumResourcesEx2 (resapi.h)

Article
03/01/2024

Énumère toutes les ressources d’un cluster spécifié et lance une opération définie par l’utilisateur pour chaque ressource. Le type PRESUTIL_ENUM_RESOURCES_EX2 définit un pointeur vers cette fonction.

Syntaxe

DWORD ResUtilEnumResourcesEx2(
  [in]           HCLUSTER               hCluster,
  [in, optional] HRESOURCE              hSelf,
  [in]           LPCWSTR                lpszResTypeName,
  [in]           LPRESOURCE_CALLBACK_EX pResCallBack,
  [in]           PVOID                  pParameter,
  [in]           DWORD                  dwDesiredAccess
);

Paramètres

[in] hCluster

Handle du cluster qui contient les ressources à énumérer.

[in, optional] hSelf

Handle facultatif pour une ressource de cluster. La fonction de rappel n’est pas appelée pour une ressource identifiée par hSelf.

[in] lpszResTypeName

Pointeur facultatif vers un nom d’un type de ressource qui réduit l’étendue des ressources à énumérer. Si lpszResTypeName est spécifié, seules les ressources du type spécifié sont énumérées.

[in] pResCallBack

Pointeur vers une fonction définie par l’utilisateur qui sera appelée pour chaque ressource énumérée. Cette fonction doit être conforme à la définition de la fonction de rappel ResourceCallbackEx (notez que les noms de paramètres ne font pas partie de la définition ; ils ont été ajoutés ici pour plus de clarté) :

DWORD (*LPRESOURCE_CALLBACK_EX)( 
  HCLUSTER hCluster,
  HRESOURCE hSelf, 
  HRESOURCE hEnum, 
  PVOID pParameter 
);

hCluster

[in] Paramètre hCluster passé à ResUtilEnumResourcesEx.

hSelf

[in] Paramètre hSelf passé à ResUtilEnumResourcesEx. Notez que la fonction de rappel n’est jamais appelée lorsque hSelf et hEnum font référence à la même ressource.

hEnum

[in] Handle de la ressource en cours d’énumération. ResUtilEnumResourcesEx ouvre et ferme automatiquement ce handle.

pParameter

[in] Mémoire tampon générique qui vous permet de passer n’importe quel type de données à la fonction de rappel.

[in] pParameter

Mémoire tampon générique qui vous permet de passer n’importe quel type de données à la fonction de rappel. ResUtilEnumResourcesEx n’utilise pas du tout ce paramètre, il transmet simplement le pointeur à la fonction de rappel. La possibilité ou non de transmettre null pour le paramètre dépend de la façon dont la fonction de rappel est implémentée.

[in] dwDesiredAccess

Privilèges d’accès demandés. Il peut s’agir d’une combinaison de GENERIC_READ (0x80000000), de GENERIC_ALL (0x10000000) ou de MAXIMUM_ALLOWED (0x02000000). Si cette valeur est égale à zéro (0), une erreur non définie peut être retournée. L’utilisation de GENERIC_ALL revient à appeler ResUtilEnumResourcesEx.

Valeur retournée

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

Si l’opération échoue, la fonction arrête immédiatement l’énumération et retourne la valeur retournée par la fonction de rappel.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows Server 2012
Plateforme cible	Windows
En-tête	resapi.h
Bibliothèque	ResUtils.lib
DLL	ResUtils.dll

Voir aussi

Fonctions utilitaires de ressources

Partager via