Función SetWindowLongA (winuser.h)

Artículo
03/15/2023

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

Nota Esta función se ha reemplazado por la función SetWindowLongPtr . Para escribir código compatible con versiones de 32 y 64 bits de Windows, use la función SetWindowLongPtr .

Sintaxis

LONG SetWindowLongA(
  [in] HWND hWnd,
  [in] int  nIndex,
  [in] LONG dwNewLong
);

Parámetros

[in] hWnd

Tipo: HWND

Identificador de la ventana y, indirectamente, la clase a la que pertenece la ventana.

[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 entero. Para establecer cualquier otro valor, especifique uno de los valores siguientes.

Valor	Significado
GWL_EXSTYLE -20	Establece un nuevo estilo de ventana extendida.
GWL_HINSTANCE -6	Establece un nuevo identificador de instancia de aplicación.
GWL_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.
GWL_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.
GWL_WNDPROC -4	Establece una nueva dirección para el procedimiento de ventana. No puede cambiar este atributo si la ventana no pertenece al mismo proceso que el subproceso que realiza la llamada.

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

Valor	Significado
DWL_DLGPROC DWLP_MSGRESULT + sizeof(LRESULT)	Establece la nueva dirección del procedimiento del cuadro de diálogo.
DWL_MSGRESULT 0	Establece el valor devuelto de un mensaje procesado en el procedimiento del cuadro de diálogo.
DWL_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

Valor de reemplazo.

Valor devuelto

Tipo: LONG

Si la función se ejecuta correctamente, el valor devuelto es el valor anterior del entero de 32 bits 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 del entero de 32 bits especificado 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. Esto hace que sea difícil determinar el éxito o el error. Para tratar esto, debe borrar la última información de error llamando a SetLastError con 0 antes de llamar a SetWindowLong. A continuación, el error de función se indicará mediante un valor devuelto de cero y un resultado GetLastError distinto de cero.

Comentarios

Ciertos datos de ventana se almacenan en caché, por lo que los cambios realizados mediante SetWindowLong no surtirán efecto hasta que llames a la función SetWindowPos . En concreto, si cambia cualquiera de los estilos de marco, debe llamar a SetWindowPos con la marca SWP_FRAMECHANGED para que la memoria caché se actualice correctamente.

Si usa SetWindowLong con el índice de GWL_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 SetWindowLong con el índice de DWL_MSGRESULT para establecer el valor devuelto de un mensaje procesado por un procedimiento 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 de diálogo reciba un mensaje de ventana, el mensaje de ventana anidado podría sobrescribir el valor devuelto que estableció mediante DWL_MSGRESULT.

Al llamar a SetWindowLong con el índice GWL_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 SetWindowLong 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 debe llamar a SetWindowLong con el índice de GWL_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_OWNDC, no establezca los estilos de ventana extendidos WS_EX_COMPOSITED o WS_EX_LAYERED.

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

Ejemplos

Para obtener un ejemplo, vea Subclase de una ventana.

Nota

El encabezado winuser.h define SetWindowLong 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

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 (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)