Función SetWindowLongPtrA (winuser.h)

Artículo
07/21/2023

Cambia un atributo de la ventana especificada. La función también establece un valor en el desplazamiento especificado en la memoria de ventana adicional.

Nota Para escribir código compatible con versiones de 32 y 64 bits de Windows, use SetWindowLongPtr. Al compilar para Windows de 32 bits, SetWindowLongPtr se define como una llamada a la función SetWindowLong .

Sintaxis

LONG_PTR SetWindowLongPtrA(
  [in] HWND     hWnd,
  [in] int      nIndex,
  [in] LONG_PTR dwNewLong
);

Parámetros

[in] hWnd

Tipo: HWND

Identificador de la ventana y, indirectamente, la clase a la que pertenece la ventana. Se produce un error en la función SetWindowLongPtr si el proceso que posee la ventana especificada por el parámetro hWnd tiene un privilegio de proceso mayor en la jerarquía de UIPI que el proceso en el que reside el subproceso que realiza la llamada.

Windows XP/2000: Se produce un error en la función SetWindowLongPtr si la ventana especificada por el parámetro hWnd no pertenece al mismo proceso que el subproceso que realiza la llamada.

[in] nIndex

Tipo: int

Desplazamiento de base cero al valor que se va a establecer. Los valores válidos están en el intervalo cero a través del número de bytes de memoria de ventana adicional, menos el tamaño de un LONG_PTR. Para establecer cualquier otro valor, especifique uno de los valores siguientes.

Valor	Significado
GWL_EXSTYLE -20	Establece un nuevo estilo de ventana extendida.
GWLP_HINSTANCE -6	Establece un nuevo identificador de instancia de aplicación.
GWLP_ID -12	Establece un nuevo identificador de la ventana secundaria. La ventana no puede ser una ventana de nivel superior.
GWL_STYLE -16	Establece un nuevo estilo de ventana.
GWLP_USERDATA -21	Establece los datos de usuario asociados a la ventana. Estos datos están diseñados para su uso por parte de la aplicación que creó la ventana. Su valor es inicialmente cero.
GWLP_WNDPROC -4	Establece una nueva dirección para el procedimiento de ventana.

Los valores siguientes también están disponibles cuando el parámetro hWnd identifica un cuadro de diálogo.

Valor	Significado
DWLP_DLGPROC DWLP_MSGRESULT + sizeof(LRESULT)	Establece el nuevo puntero al procedimiento del cuadro de diálogo.
DWLP_MSGRESULT 0	Establece el valor devuelto de un mensaje procesado en el procedimiento del cuadro de diálogo.
DWLP_USER DWLP_DLGPROC + sizeof(DLGPROC)	Establece información adicional nueva que es privada para la aplicación, como identificadores o punteros.

[in] dwNewLong

Tipo: LONG_PTR

Valor de reemplazo.

Valor devuelto

Tipo: LONG_PTR

Si la función se ejecuta correctamente, el valor devuelto es el valor anterior del desplazamiento especificado.

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

Si el valor anterior es cero y la función se ejecuta correctamente, el valor devuelto es cero, pero la función no borra la última información de error. Para determinar el éxito o el error, borre la última información de error llamando a SetLastError con 0 y, a continuación, llame a SetWindowLongPtr. El error de función se indicará mediante un valor devuelto de cero y un resultado GetLastError distinto de cero.

Observaciones

Ciertos datos de ventana se almacenan en caché, por lo que los cambios realizados mediante SetWindowLongPtr no surtirán efecto hasta que llame a la función SetWindowPos .

Si usa SetWindowLongPtr con el índice de GWLP_WNDPROC para reemplazar el procedimiento de ventana, el procedimiento de ventana debe cumplir las directrices especificadas en la descripción de la función de devolución de llamada WindowProc .

Si usa SetWindowLongPtr con el índice de DWLP_MSGRESULT para establecer el valor devuelto de un mensaje procesado por un procedimiento de cuadro de diálogo, el procedimiento del cuadro de diálogo debe devolver TRUE directamente después. De lo contrario, si llama a cualquier función que dé lugar a que el procedimiento del cuadro de diálogo reciba un mensaje de ventana, el mensaje de la ventana anidada podría sobrescribir el valor devuelto que estableció mediante DWLP_MSGRESULT.

Al llamar a SetWindowLongPtr con el índice GWLP_WNDPROC , se crea una subclase de la clase de ventana utilizada para crear la ventana. Una aplicación puede subclase una clase del sistema, pero no debe subclase una clase de ventana creada por otro proceso. La función SetWindowLongPtr crea la subclase de ventana cambiando el procedimiento de ventana asociado a una clase de ventana determinada, lo que hace que el sistema llame al nuevo procedimiento de ventana en lugar del anterior. Una aplicación debe pasar los mensajes no procesados por el nuevo procedimiento de ventana al procedimiento de ventana anterior llamando a CallWindowProc. Esto permite a la aplicación crear una cadena de procedimientos de ventana.

Reserve memoria de ventana adicional especificando un valor distinto de cero en el miembro cbWndExtra de la estructura WNDCLASSEX utilizada con la función RegisterClassEx .

No llame a SetWindowLongPtr con el índice de GWLP_HWNDPARENT para cambiar el elemento primario de una ventana secundaria. En su lugar, use la función SetParent .

Si la ventana tiene un estilo de clase de CS_CLASSDC o CS_PARENTDC, no establezca los estilos de ventana extendidos WS_EX_COMPOSITED o WS_EX_LAYERED.

Al llamar a SetWindowLongPtr para establecer el estilo en una barra de progreso, se restablecerá su posición.

Nota:

El encabezado winuser.h define SetWindowLongPtr 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos


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 (incluya Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-windowclass-l1-1-0 (introducido en Windows 8)