检索发生错误的上下文的说明。
语法
HRESULT GetErrorContextDescription(
[in] DWORD LanguageId,
[out] LPWSTR *pContextDescription
);
参数
[in] LanguageId
标识用于生成说明的区域设置。 若要创建语言标识符,请使用 MAKELANGID 宏。 例如,若要指定美国英语,请使用以下代码示例。
MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US)
若要检索系统的默认用户语言标识符,请使用以下调用。
LANGIDFROMLCID(GetThreadLocale())
[out] pContextDescription
以 Null 结尾的字符串,其中包含发生错误的上下文的说明。 完成后,调用 CoTaskMemFree 函数以释放 ppContextDescription 。
返回值
此方法返回以下 HRESULT 值以及其他值。
| 返回代码 | 说明 |
|---|---|
|
已成功检索上下文的说明。 |
|
没有足够的可用内存来完成该操作。 |
|
LanguageId 参数不能为 0。 |
|
区域设置没有可用的字符串。 |
要求
| 要求 | 值 |
|---|---|
| 最低受支持的客户端 | Windows XP |
| 最低受支持的服务器 | Windows Server 2003 |
| 目标平台 | Windows |
| 标头 | bits.h |
| Library | Bits.lib |
| DLL | QmgrPrxy.dll |
另请参阅
IBackgroundCopyError::GetError