CFileException::GetErrorMessage
例外を説明するテキストを取得します。
virtual BOOL GetErrorMessage(
LPTSTR lpszError,
UINT nMaxError,
PUINT pnHelpContext = NULL
) const;
パラメーター
[入力、出力] lpszError
エラー メッセージを受け取るバッファーへのポインター。[入力] nMaxError
指定されたバッファーに保持できる最大文字数。終端の NULL 文字を含みます。[入力、出力] pnHelpContext
ヘルプ コンテキスト ID を受け取る符号なし整数へのポインター。NULL の場合、ID は返されません。
戻り値
メソッドが正常に実行された場合は TRUE。それ以外の場合は FALSE。
解説
指定したバッファーが小さすぎると、エラー メッセージは切り捨てられます。
使用例
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();
}
必要条件
ヘッダー : afx.h