Метод IBackgroundCopyError::GetErrorDescription (bits.h)

Извлекает текст ошибки, связанный с ошибкой.

Синтаксис

HRESULT GetErrorDescription(
  [in]  DWORD  LanguageId,
  [out] LPWSTR *pErrorDescription
);

Параметры

[in] LanguageId

Определяет языковой стандарт, используемый для создания описания. Чтобы создать идентификатор языка, используйте макрос MAKELANGID . Например, чтобы указать английский язык (США), используйте следующий пример кода.

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

Чтобы получить идентификатор языка пользователя по умолчанию в системе, используйте следующие вызовы.

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

Строка, завершающаяся значением NULL, содержащая текст ошибки, связанный с ошибкой. По завершении вызовите функцию CoTaskMemFree , чтобы освободить ppErrorDescription .

Возвращаемое значение

Этот метод возвращает следующие значения HRESULT , а также другие.

Код возврата Описание
S_OK
Описание ошибки успешно получено.
E_OUTOFMEMORY
Недостаточно памяти для выполнения операции.
E_INVALIDARG
Параметр LanguageId не может иметь значение 0.
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)
Для языкового стандарта нет доступной строки.

Комментарии

Вы также можете вызвать метод IBackgroundCopyManager::GetErrorDescription , чтобы получить текст ошибки, связанный с кодом ошибки.

Описания ошибок HTTP локализованы.

Windows XP/2000: Описания ошибок HTTP не локализованы.

Примеры

См. пример кода в разделе Обработка ошибок .

Требования

Требование Значение
Минимальная версия клиента Windows XP
Минимальная версия сервера Windows Server 2003
Целевая платформа Windows
Header bits.h
Библиотека Bits.lib
DLL QmgrPrxy.dll

См. также раздел

IBackgroundCopyError::GetError

IBackgroundCopyError::GetErrorContextDescription

IBackgroundCopyError::GetFile

IBackgroundCopyManager::GetErrorDescription