SetPropA, fonction (winuser.h)

Article
03/04/2024

Ajoute une nouvelle entrée ou modifie une entrée existante dans la liste de propriétés de la fenêtre spécifiée. La fonction ajoute une nouvelle entrée à la liste si la chaîne de caractères spécifiée n’existe pas déjà dans la liste. La nouvelle entrée contient la chaîne et le handle. Sinon, la fonction remplace le handle actuel de la chaîne par le handle spécifié.

Syntaxe

BOOL SetPropA(
  [in]           HWND   hWnd,
  [in]           LPCSTR lpString,
  [in, optional] HANDLE hData
);

Paramètres

[in] hWnd

Type : HWND

Handle de la fenêtre dont la liste de propriétés reçoit la nouvelle entrée.

[in] lpString

Type : LPCTSTR

Chaîne terminée par null ou atome qui identifie une chaîne. Si ce paramètre est un atome, il doit s’agir d’un atome global créé par un appel précédent à la fonction GlobalAddAtom . L’atome doit être placé dans le mot d’ordre inférieur de lpString ; le mot d’ordre élevé doit être égal à zéro.

[in, optional] hData

Type : HANDLE

Handle des données à copier dans la liste de propriétés. Le handle de données peut identifier toute valeur utile pour l’application.

Valeur retournée

Type : BOOL

Si le handle et la chaîne de données sont ajoutés à la liste de propriétés, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Avant qu’une fenêtre ne soit détruite (c’est-à-dire avant qu’elle ne revienne du traitement du message WM_NCDESTROY ), une application doit supprimer toutes les entrées qu’elle a ajoutées à la liste de propriétés. L’application doit utiliser la fonction RemoveProp pour supprimer les entrées.

SetProp est soumis aux restrictions de l’isolation des privilèges d’interface utilisateur (UIPI). Un processus peut uniquement appeler cette fonction sur une fenêtre appartenant à un processus de niveau d’intégrité inférieur ou égal. Lorsque UIPI bloque les modifications de propriété, GetLastError retourne la valeur 5.

Exemples

Pour obtenir un exemple, consultez Ajout d’une propriété window.

Notes

L’en-tête winuser.h définit SetProp comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winuser.h (inclure Windows.h)
Bibliothèque	User32.lib
DLL	User32.dll
Ensemble d’API	ext-ms-win-ntuser-window-l1-1-4 (introduit dans Windows 10, version 10.0.14393)