AfxMessageBox

Muestra un cuadro de mensaje en la pantalla.

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
    Señala a un objeto de CString o una cadena terminada en null que contiene el mensaje que se mostrará en el cuadro de mensaje.

  • nType
    Estilo del cuadro de mensaje. Aplicar cualquiera de los estilos del cuadro de mensaje al cuadro.

  • nIDHelp
    El identificador de contexto de ayuda para el mensaje; 0 indica que se utilizará el contexto de ayuda de la aplicación.

  • nIDPrompt
    Un identificador único que se usa para hacer referencia a una cadena en la tabla de cadenas.

Valor devuelto

Cero si no hay memoria suficiente para mostrar el cuadro de mensaje; si no, uno de los valores siguientes se devuelve:

  • IDABORT Se seleccionó el botón Anular.

  • IDCANCEL Se seleccionó el botón Cancelar.

  • IDIGNORE Se seleccionó el botón Omitir.

  • IDNO Se seleccionó el botón No.

  • IDOK Se seleccionó el botón Aceptar.

  • IDRETRY Se seleccionó el botón Reintentar.

  • IDYES Se seleccionó el botón Sí.

Si un cuadro de mensaje tiene un botón Cancelar, el valor de IDCANCEL se devolverá si se presiona la tecla ESC o se selecciona el botón Cancelar. Si el cuadro de mensaje no tiene un botón Cancelar, presionar la tecla ESC no tiene ningún efecto.

Las funciones AfxFormatString1 y AfxFormatString2 pueden resultar útiles para dar formato al texto que aparece en un cuadro de mensaje.

Comentarios

El primer formulario de esta función sobrecargada muestra una cadena de texto a la que señala lpszText en el cuadro de mensaje y utiliza nIDHelp para describir un contexto de ayuda. El contexto de ayuda se utiliza para saltar a un tema de ayuda asociado cuando el usuario presione la tecla de ayuda (normalmente F1).

El segundo formato de la función utiliza el recurso de cadena con el identificador nIDPrompt para mostrar un mensaje en el cuadro de mensaje. La página de ayuda asociada se encuentra con el valor de nIDHelp. Si se usa el valor predeterminado de nIDHelp (– 1), el id. de recurso de cadena, nIDPrompt, se utiliza para el contexto de Ayuda. Para obtener más información sobre cómo definir contextos de Ayuda, vea Nota técnica 28.

Ejemplo

// 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

Encabezado: afxwin.h

Vea también

Referencia

CWnd::MessageBox

Conceptos

Macros y variables globales de MFC