CComCoClass::Error

Artigo
02/25/2013

Essa função estática configura a interface de IErrorInfo para fornecer informações de erro para o cliente.

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() 
);

Parâmetros

lpszDesc
[in] a cadeia de caracteres que descreve o erro.A versão Unicode de Error especifica que lpszDesc é do tipo LPCOLESTR; a versão ANSI especifica um tipo de LPCSTR.
iid
[in] O IID de interface que define o erro ou GUID_NULL (o valor padrão) se o erro é definido pelo sistema operacional.
hRes
[in] HRESULT você deseja retornado para o chamador.o valor padrão é 0.Para mais detalhes sobre hRes, consulte comentários.
nID
[in] o identificador do recurso onde a cadeia de caracteres de descrição de erro é armazenada.Esse valor deve encontrar-se entre 0x0200 e 0xFFFF, inclusiva.Em compilações de depuração, ASSERT resultará se nID não indexa uma cadeia de caracteres válido.Em construções de versão, a cadeia de caracteres de descrição de erro será “error” não definido.
dwHelpID
[in] o identificador do contexto da ajuda para o erro.
lpszHelpFile
[in] o caminho e o nome da ajuda arquivo a descrição do erro.
hInst
[in] o identificador do recurso.Por padrão, este parâmetro é _AtlModule::GetResourceInstance, onde é _AtlModule a instância global de CAtlModule.

Valor de retorno

Um valor padrão de HRESULT .Para obter detalhes, consulte comentários.

Comentários

Para chamar Error, o objeto deve implementar a interface de ISupportErrorInfo Interface .

Se o parâmetro de hRes é diferente de zero, então Error retorna o valor de hRes.Se hRes é zero, então os primeiros quatro versões de retorno DISP_E_EXCEPTIONde Error .As duas versões mais recentes retornar o resultado de MAKE_HRESULT( 1, FACILITY_ITF, macronID ).

Requisitos

Cabeçalho: atlcom.h

Consulte também

Referência

Classe de CComCoClass

Classe de ISupportErrorInfoImpl

MAKE_HRESULT

Compartilhar via