Função GetWindowLongA (winuser.h)

Artigo
08/08/2024

Recupera informações sobre a janela especificada. A função também recupera o valor DWORD (32 bits) no deslocamento especificado para a memória extra da janela.

Nota Se você estiver recuperando um ponteiro ou um identificador, essa função foi substituída pela função GetWindowLongPtr . (Ponteiros e identificadores são de 32 bits no Windows de 32 bits e 64 bits no Windows de 64 bits.) Para escrever código compatível com versões de 32 bits e 64 bits do Windows, use GetWindowLongPtr.

Sintaxe

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

Parâmetros

[in] hWnd

Digite: HWND

Um identificador para a janela e, indiretamente, a classe à qual a janela pertence.

[in] nIndex

Tipo: int

O deslocamento baseado em zero para o valor a ser recuperado. Os valores válidos estão no intervalo zero até o número de bytes de memória de janela extra, menos quatro; por exemplo, se você especificasse 12 ou mais bytes de memória extra, um valor de 8 seria um índice para o terceiro inteiro de 32 bits. Para recuperar qualquer outro valor, especifique um dos valores a seguir.

Valor	Significado
GWL_EXSTYLE -20	Recupera os estilos de janela estendidos.
GWL_HINSTANCE -6	Recupera um identificador para a instância do aplicativo.
GWL_HWNDPARENT -8	Recupera um identificador para a janela pai, se houver.
GWL_ID -12	Recupera o identificador da janela.
GWL_STYLE -16	Recupera os estilos de janela.
GWL_USERDATA -21	Recupera os dados do usuário associados à janela. Esses dados são destinados ao uso pelo aplicativo que criou a janela. Seu valor é inicialmente zero.
GWL_WNDPROC -4	Recupera o endereço do procedimento de janela ou um identificador que representa o endereço do procedimento de janela. Você deve usar a função CallWindowProc para chamar o procedimento de janela.

Os valores a seguir também estão disponíveis quando o parâmetro hWnd identifica uma caixa de diálogo.

Valor	Significado
DWL_DLGPROC DWLP_MSGRESULT + sizeof(LRESULT)	Recupera o endereço do procedimento da caixa de diálogo ou um identificador que representa o endereço do procedimento da caixa de diálogo. Você deve usar a função CallWindowProc para chamar o procedimento da caixa de diálogo.
DWL_MSGRESULT 0	Recupera o valor retornado de uma mensagem processada no procedimento da caixa de diálogo.
DWL_USER DWLP_DLGPROC + sizeof(DLGPROC)	Recupera informações adicionais privadas para o aplicativo, como identificadores ou ponteiros.

Retornar valor

Tipo: LONG

Se a função for bem-sucedida, o valor retornado será o valor solicitado.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Se SetWindowLong não tiver sido chamado anteriormente, GetWindowLong retornará zero para valores na janela extra ou na memória de classe.

Comentários

Reserve memória de janela extra especificando um valor diferente de zero no membro cbWndExtra da estrutura WNDCLASSEX usada com a função RegisterClassEx .

Exemplos

Para obter um exemplo, consulte Criando, enumerando e dimensionando janelas filho.

Observação

O cabeçalho winuser.h define GetWindowLong como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-windowclass-l1-1-0 (introduzido em Windows 8)