CFileException::GetErrorMessage

Artículo
06/10/2015

Texto de recupera que describe la excepción.

virtual BOOL GetErrorMessage(
   LPTSTR lpszError,
   UINT nMaxError,
   PUINT pnHelpContext = NULL 
) const;

Parámetros

[in, out] lpszError
Puntero a un búfer que recibe un mensaje de error.
[in] nMaxError
El número máximo de caracteres que el búfer especificado puede contener. Esto incluye el carácter null de terminación.
[in, out] pnHelpContext
Puntero a un entero sin signo que recibe el identificador de contexto de ayuda Si se devuelve NULL, ningún id.

Valor devuelto

TRUE si el método fue correcto; si no FALSE.

Comentarios

Si el búfer especificado es demasiado pequeño, se trunca el mensaje de error.

Ejemplo

El ejemplo siguiente utiliza CFileException::GetErrorMessage.

CFile fileInput;
CFileException ex;

// try to open a file for reading. 
// The file will certainly not 
// exist because there are too many explicit 
// directories in the name. 

// if the call to Open() fails, ex will be 
// initialized with exception 
// information.  the call to ex.GetErrorMessage() 
// will retrieve an appropriate message describing 
// the error, and we'll add our own text 
// to make sure the user is perfectly sure what 
// went wrong. 

if (!fileInput.Open(_T("\\Too\\Many\\Bad\\Dirs.DAT"), CFile::modeRead, &ex))
{
   TCHAR   szCause[255];
   CString strFormatted;

   ex.GetErrorMessage(szCause, 255);

   // (in real life, it's probably more 
   // appropriate to read this from 
   //  a string resource so it would be easy to 
   // localize)

   strFormatted = _T("The data file could not be opened because of this error: ");
   strFormatted += szCause;

   AfxMessageBox(strFormatted);
}
else
{
   // the file was opened, so do whatever work 
   // with fileInput 
   // we were planning...

   fileInput.Close();
}