Share via

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

  • Статья

Возвращает описание для указанного кода ошибки.

Синтаксис

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

Параметры

[in] hResult

Код ошибки из предыдущего вызова метода BITS.

[in] LanguageId

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

MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)

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

LANGIDFROMLCID(GetThreadLocale())

[out] pErrorDescription

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

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

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

Код возврата Описание
S_OK
 Описание кода ошибки успешно получено.
HRESULT_FROM_WIN32(ERROR_RESOURCE_LANG_NOT_FOUND)
 Для языкового стандарта нет доступной строки.

Комментарии

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

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

Примеры

В следующем примере показано, как получить описание, связанное с кодом ошибки. Переменная g_XferManager в этом примере является указателем интерфейса IBackgroundCopyManager . Дополнительные сведения о создании указателя интерфейса IBackgroundCopyManager см. в разделе Подключение к службе BITS.

HRESULT hr = 0;
IBackgroundCopyJob* pJob = NULL;
WCHAR* pszDescription = NULL;

//Call fails because the third parameter is NULL.
hr = g_XferManager->CreateJob(L"DummyJob", BG_JOB_TYPE_DOWNLOAD, NULL, &pJob);
if (FAILED(hr))
{
  hr = g_XferManager->GetErrorDescription(hr, LANGIDFROMLCID(GetThreadLocale()), &pszDescription);
  if (SUCCEEDED(hr))
  {
    //Do something with pszDescription.
    CoTaskMemFree(pszDescription);
  }
}

Требования

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

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

Обработка ошибок

IBackgroundCopyError

IBackgroundCopyJob::GetError