Função EndDialog (winuser.h)

Artigo
03/04/2024

Destrói uma caixa de diálogo modal, fazendo com que o sistema encerre qualquer processamento para a caixa de diálogo.

Sintaxe

BOOL EndDialog(
  [in] HWND    hDlg,
  [in] INT_PTR nResult
);

Parâmetros

[in] hDlg

Digite: HWND

Um identificador para a caixa de diálogo a ser destruída.

[in] nResult

Tipo: INT_PTR

O valor a ser retornado ao aplicativo da função que criou a caixa de diálogo.

Retornar valor

Tipo: BOOL

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

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

Comentários

As caixas de diálogo criadas pelas funções DialogBox, DialogBoxParam, DialogBoxIndirect e DialogBoxIndirectParam devem ser destruídas usando a função EndDialog . Um aplicativo chama EndDialog de dentro do procedimento da caixa de diálogo; a função não deve ser usada para nenhuma outra finalidade.

Um procedimento de caixa de diálogo pode chamar EndDialog a qualquer momento, mesmo durante o processamento da mensagem WM_INITDIALOG . Se o aplicativo chamar a função enquanto WM_INITDIALOG estiver sendo processada, a caixa de diálogo será destruída antes de ser mostrada e antes que o foco de entrada seja definido.

EndDialog não destrói a caixa de diálogo imediatamente. Em vez disso, ele define um sinalizador e permite que o procedimento da caixa de diálogo retorne o controle ao sistema. O sistema verifica o sinalizador antes de tentar recuperar a próxima mensagem da fila do aplicativo. Se o sinalizador estiver definido, o sistema encerrará o loop de mensagem, destruirá a caixa de diálogo e usará o valor em nResult como o valor retornado da função que criou a caixa de diálogo.

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-dialogbox-l1-1-0 (introduzido em Windows 8)