Fonction ResUtilSetPrivatePropertyList (resapi.h)

Article
03/04/2024

Définit les propriétés privées d’un objet de cluster.

Syntaxe

DWORD ResUtilSetPrivatePropertyList(
  [in] HKEY        hkeyClusterKey,
  [in] const PVOID pInPropertyList,
  [in] DWORD       cbInPropertyListSize
);

Paramètres

[in] hkeyClusterKey

Clé de base de données de cluster identifiant l’emplacement des propriétés à définir.

[in] pInPropertyList

Pointeur vers une mémoire tampon d’entrée contenant une liste de propriétés avec les noms et les valeurs des propriétés à définir.

[in] cbInPropertyListSize

Pointeur vers la taille en octets de la mémoire tampon d’entrée pointée par pInPropertyList.

Valeur retournée

Si l’opération réussit, 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 paramètres d’entrée n’étaient pas valides.
ERROR_INVALID_DATA	Il y a eu un problème avec la longueur des données d’une propriété.
ERROR_INSUFFICIENT_BUFFER	La mémoire tampon d’entrée pointée par pInPropertyList était NULL.
ERROR_INVALID_PARAMETER	La syntaxe d’un nom de propriété n’était pas valide.

Remarques

Les propriétés définies dans la fonction utilitaire ResUtilSetPrivatePropertyList sont placées dans la partie de la base de données de cluster sous la clé spécifiée pour l’objet exactement comme spécifié par les noms dans la liste de propriétés. Si le nom d’une propriété contient des caractères de barre oblique inverse (\), chaque chaîne précédant une barre oblique inverse est interprétée comme un nom de sous-clé, et la dernière chaîne qui suit la dernière barre oblique inverse est interprétée comme le nom de la valeur.

N’appelez pas ResUtilSetPrivatePropertyList à partir des fonctions de point d’entrée dll de ressource suivantes :

ResUtilSetPrivatePropertyList peut être appelé en toute sécurité à partir de n’importe quelle autre fonction de point d’entrée DLL de ressource ou à partir d’un thread de travail. Pour plus d’informations, consultez Appels de fonction à éviter dans les DLL de ressources.

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

Voir aussi

ResUtilVerifyPrivatePropertyList

Partager via