Fonction ResUtilGetAllProperties (resapi.h)

Article
08/25/2023

Retourne une liste de propriétés qui inclut toutes les propriétés par défaut et inconnues d’un objet de cluster. Le type PRESUTIL_GET_ALL_PROPERTIES définit un pointeur vers cette fonction.

Syntaxe

DWORD ResUtilGetAllProperties(
  [in]  HKEY                         hkeyClusterKey,
  [in]  const PRESUTIL_PROPERTY_ITEM pPropertyTable,
  [out] PVOID                        pOutPropertyList,
  [in]  DWORD                        cbOutPropertyListSize,
  [out] LPDWORD                      pcbBytesReturned,
  [out] LPDWORD                      pcbRequired
);

Paramètres

[in] hkeyClusterKey

Pointeur vers la clé de base de données de cluster qui identifie l’emplacement des propriétés à récupérer.

[in] pPropertyTable

Pointeur vers un tableau de structures RESUTIL_PROPERTY_ITEM qui décrivent les propriétés à récupérer.

[out] pOutPropertyList

Pointeur vers une mémoire tampon de sortie dans laquelle renvoyer la liste de propriétés.

[in] cbOutPropertyListSize

Taille en octets de la mémoire tampon de sortie pointée par OutBuffer.

[out] pcbBytesReturned

Pointeur vers le nombre total d’octets dans la liste de propriétés pointée par OutBuffer.

[out] pcbRequired

Pointeur vers le nombre d’octets requis si OutBuffer est trop petit.

Valeur retournée

Si les opérations réussissent, la fonction retourne ERROR_SUCCESS.

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

Code de retour	Description
ERROR_BAD_ARGUMENTS	Un ou plusieurs des paramètres d’entrée n’étaient pas valides.
ERROR_NOT_ENOUGH_MEMORY	Une erreur s’est produite lors de l’allocation de la mémoire.
ERROR_MORE_DATA	La taille de la mémoire tampon de sortie est trop petite pour contenir les données obtenues. Le paramètre pcbRequired pointe vers la taille correcte.

Notes

La fonction utilitaire ResUtilGetAllProperties crée une entrée dans la liste de propriétés pour chaque propriété qui est :

Inclus dans la table de propriétés.
Inclus dans la base de données de cluster sous la clé identifiée par le paramètre ClusterKey , que la propriété soit incluse ou non dans la table de propriétés.

Spécifications


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	resapi.h
Bibliothèque	ResUtils.lib
DLL	ResUtils.dll

Voir aussi

RESUTIL_PROPERTY_ITEM

Partager via