AfxMessageBox
Exibe uma caixa de mensagem na tela.
int AfxMessageBox(
LPCTSTR lpszText,
UINT nType = MB_OK,
UINT nIDHelp = 0
);
int AFXAPI AfxMessageBox(
UINT nIDPrompt,
UINT nType = MB_OK,
UINT nIDHelp = (UINT
) -1
);
Parâmetros
lpszText
Aponta para um objeto CString ou cadeia de caracteres terminada por nulo que contém a mensagem a ser exibida na caixa de mensagem.nType
O estilo da caixa de mensagem. Aplique qualquer um dos estilos da caixa de mensagem à caixa.nIDHelp
A ID do contexto da Ajuda para a mensagem; 0 indica que o contexto padrão da Ajuda do aplicativo será usado.nIDPrompt
Uma ID exclusiva usada para fazer referência a uma cadeia de caracteres na tabela de cadeia de caracteres.
Valor de retorno
Zero se não houver memória suficiente para exibir a caixa de mensagem; caso contrário, um dos seguintes valores será retornado:
IDABORT O botão Anular foi selecionado.
IDCANCEL O botão Cancelar foi selecionado.
IDIGNORE O botão Ignorar foi selecionado.
IDNO O botão Não foi selecionado.
IDOK O botão OK foi selecionado.
IDRETRY O botão Tentar Novamente foi selecionado.
IDYES O botão Sim foi selecionado.
Se uma caixa de mensagem tem um botão Cancelar, o valor IDCANCEL será retornado se a tecla ESC for pressionada ou o botão Cancelar for selecionado. Se a caixa de mensagem não tiver nenhum botão Cancelar, pressionar a tecla ESC não terá efeito.
As funções AfxFormatString1 e AfxFormatString2 podem ser úteis em formatação de texto que aparece em uma caixa de mensagem.
Comentários
A primeira forma dessa função sobrecarregada exibe uma cadeia de texto apontada por lpszText na caixa de mensagem e usa nIDHelp para descrever um contexto da Ajuda. O contexto da Ajuda é usado para pular para um tópico da Ajuda associado quando o usuário pressionar a tecla da Ajuda (normalmente F1).
O segundo formato da função usa o recurso de cadeia de caracteres com a identificação nIDPrompt para exibir uma mensagem a caixa de mensagem. A página da Ajuda associada é encontrada por meio do valor de nIDHelp. Se o valor padrão de nIDHelp for usado (– 1), a identificação de recurso da cadeia de caracteres, nIDPrompt, será usada para o contexto da Ajuda. Para obter mais informações sobre como definir contextos da Ajuda, consulte a Nota técnica 28.
Exemplo
// A simple message box, with only the OK button.
AfxMessageBox(_T("Simple message box."));
// A message box that uses a string from a string table
// with yes and no buttons and the stop icon.
// NOTE: nStringID is an integer that contains a valid id of
// a string in the current resource.
AfxMessageBox(nStringID, MB_YESNO|MB_ICONSTOP);
Requisitos
Cabeçalho: afxwin.h