CFileException::GetErrorMessage

Artigo
06/10/2015

Recupera o texto que descreve uma exceção.

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

Parâmetros

Em, [out] lpszError
Ponteiro para um buffer que receberá uma mensagem de erro.
[in] nMaxError
O número máximo de caracteres que o buffer especificada pode conter. Isso inclui o caractere de terminação zero.
Em, [out] pnHelpContext
Ponteiro para um número inteiro sem sinal que receba a identificação de contexto da ajuda Se NULL, nenhuma identificação é retornado.

Valor de retorno

TRUE se o método tenha êxito; se não FALSE.

Comentários

Se o buffer especificado é pequeno, a mensagem de erro será truncada.

Exemplo

O exemplo a seguir usa 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();
}