SetPropW, fonction (winuser.h)

Article
11/20/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 SetPropW(
  [in]           HWND    hWnd,
  [in]           LPCWSTR lpString,
  [in, optional] HANDLE  hData
);

Paramètres

[in] hWnd

Type : HWND

Handle vers 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 de bas ordre de lpString; le mot de haut ordre doit être égal à zéro.

[in, optional] hData

Type : HANDLE

Handle vers les données à copier dans la liste des propriétés. Le handle de données peut identifier n’importe quelle valeur utile à l’application.

Valeur de retour

Type : BOOL

Si le handle de données et la chaîne sont ajoutés à la liste des propriétés, la valeur de retour n’est pas nulle.

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

Remarques

Avant la destruction d’une fenêtre (autrement dit, avant de retourner le traitement du message WM_NCDESTROY), une application doit supprimer toutes les entrées qu’elle a ajoutées à la liste des 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 ne peut appeler cette fonction que sur une fenêtre appartenant à un processus de niveau d’intégrité inférieur ou égal. Lorsque l’UIPI bloque les modifications des propriétés, GetLastError retourne 5.

Exemples

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

Note

L’en-tête winuser.h définit SetProp comme 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	winuser.h (include 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)