CComCoClass::Error

此静态函数设置 IErrorInfo 接口提供错误信息到客户端。

static HRESULT WINAPI Error(
   LPCOLESTR lpszDesc,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0 
);
static HRESULT WINAPI Error(
   LPCOLESTR lpszDesc,
   DWORD dwHelpID,
   LPCOLESTR lpszHelpFile,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0 
);
static HRESULT WINAPI Error(
   LPCSTR lpszDesc,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0 
);
static HRESULT WINAPI Error(
   LPCSTR lpszDesc,
   DWORD dwHelpID,
   LPCSTR lpszHelpFile,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0 
);
static HRESULT WINAPI Error(
   UINT nID,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0,
   HINSTANCE hInst = _AtlBaseModule.GetResourceInstance ()
);
static HRESULT Error(
   UINT nID,
   DWORD dwHelpID,
   LPCOLESTR lpszHelpFile,
   const IID& iid = GUID_NULL,
   HRESULT hRes = 0,
   HINSTANCE hInst = _AtlBaseModule.GetResourceInstance() 
);

参数

  • lpszDesc
    [in]描述错误的字符串。Error 的Unicode版本指定 lpszDesc 是类型 LPCOLESTR;ANSI版本指定 LPCSTR的类型。

  • iid
    [in]定义错误或 GUID_NULL (默认值)的接口的IID,如果错误由操作系统定义的。

  • hRes
    [in]要返回到调用方的 HRESULT。默认值为 0。有关更多详细信息有关 hRes,请参见备注。

  • nID
    [in]存储错误说明字符串的资源标识符。此值应放在0x0200和0xFFFF之间,包含。如果 nID 不索引有效的字符串,在调试版本中,ASSERT 将发生。在发布版本中,错误说明的字符串将设置为“未知错误”。

  • dwHelpID
    [in]错误的帮助上下文标识符。

  • lpszHelpFile
    [in]描述错误的帮助文件的路径和名称。

  • hInst
    [out]一个指向资源的句柄。默认情况下,此参数是 _AtlModule::GetResourceInstance_AtlModuleCAtlModule全局实例。

返回值

标准 HRESULT 值。有关详细信息,请参见备注。

备注

若要调用 Error,对象必须实现 ISupportErrorInfo Interface 接口。

如果 hRes 参数不为零,则 Error 返回 hRes的值。如果 hRes 为零,则 Error 的前四个版本返回 DISP_E_EXCEPTION。前两个版本返回宏 MAKE_HRESULT( 1, FACILITY_ITF, nID **)**的结果。

要求

Header: atlcom.h

请参见

参考

CComCoClass选件类

ISupportErrorInfoImpl选件类

MAKE_HRESULT