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
标头 bits.h
Library Bits.lib
DLL QmgrPrxy.dll

另请参阅

IBackgroundCopyError::GetError

IBackgroundCopyError::GetErrorContextDescription

IBackgroundCopyError::GetFile

IBackgroundCopyManager::GetErrorDescription