Función SetPropA (winuser.h)

Artículo
03/13/2024

Agrega una nueva entrada o cambia una entrada existente en la lista de propiedades de la ventana especificada. La función agrega una nueva entrada a la lista si la cadena de caracteres especificada aún no existe en la lista. La nueva entrada contiene la cadena y el identificador. De lo contrario, la función reemplaza el identificador actual de la cadena por el identificador especificado.

Sintaxis

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

Parámetros

[in] hWnd

Tipo: HWND

Identificador de la ventana cuya lista de propiedades recibe la nueva entrada.

[in] lpString

Tipo: LPCTSTR

Cadena terminada en null o un átomo que identifica una cadena. Si este parámetro es un átomo, debe ser un átomo global creado por una llamada anterior a la función GlobalAddAtom . El átomo debe colocarse en la palabra de orden bajo de lpString; la palabra de orden superior debe ser cero.

[in, optional] hData

Tipo: HANDLE

Identificador de los datos que se van a copiar en la lista de propiedades. El identificador de datos puede identificar cualquier valor útil para la aplicación.

Valor devuelto

Tipo: BOOL

Si el identificador de datos y la cadena se agregan a la lista de propiedades, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Antes de destruir una ventana (es decir, antes de que vuelva de procesar el mensaje de WM_NCDESTROY ), una aplicación debe quitar todas las entradas que ha agregado a la lista de propiedades. La aplicación debe usar la función RemoveProp para quitar las entradas.

SetProp está sujeto a las restricciones del aislamiento de privilegios de la interfaz de usuario (UIPI). Un proceso solo puede llamar a esta función en una ventana que pertenezca a un proceso de nivel de integridad menor o igual. Cuando UIPI bloquea los cambios de propiedad, GetLastError devolverá 5.

Ejemplos

Para obtener un ejemplo, vea Agregar una propiedad Window.

Nota

El encabezado winuser.h define SetProp como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluir Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-window-l1-1-4 (introducido en Windows 10, versión 10.0.14393)