AtlReportError

HRESULT WINAPI AtlReportError (const CLSIDamp; CLSID, LPCOLESTR lpszDescconst IID & IID = GUID_NULL, HRESULT hRes = 0 );

HRESULT WINAPI AtlReportError (const CLSIDamp; CLSID, LPCOLESTR lpszDescDWORDdwHelpIDLPCOLESTRlpszHelpFileconst IID & IID = GUID_NULL, HRESULT hRes = 0 );

HRESULT WINAPI AtlReportError (const CLSIDamp; CLSID, LPCSTR lpszDesc, const IID & IID = GUID_NULL, HRESULT hRes = 0 );

HRESULT WINAPI AtlReportError (const CLSIDamp; CLSID, LPCSTR lpszDescDWORDdwHelpIDLPCSTRlpszHelpFileconst IID & IID = GUID_NULL, HRESULT hRes = 0 );

HRESULT WINAPI AtlReportError (const CLSIDamp; CLSID, UINT nID, const IID & IID = GUID_NULL, HRESULT hRes = 0, HINSTANCEhInst= _Module.GetResourceInstance ());

HRESULT WINAPI AtlReportError (const CLSIDamp; CLSID, UINT nIDDWORDdwHelpIDLPCOLESTRlpszHelpFileconst IID & IID = GUID_NULL, HRESULT hRes = 0, HINSTANCEhInst= _Module.GetResourceInstance ());

Valor de retorno

Se o parâmetro hRes for diferente de zero, retorna o valor de hRes. Se hRes for zero, em seguida, as quatro primeiras versões do AtlReportError retornam DISP_E_EXCEPTION. As duas Último versões retornam o resultado da macro MAKE_HRESULT (1, FACILITY_ITF, nID ).

Parâmetros

clsid

[no] O CLSID do objeto relatar o erro.

lpszDesc

[no] A Cadeia de caracteres descrevendo o erro. A versão Unicode Especifica que lpszDesc é do tipo LPCOLESTR; a versão ANSI Especifica um tipo de LPCSTR.

iid

[no] O IID da interface definindo o erro ou GUID_NULL se o erro é definido pelo sistema operacional.

hRes

[no] O HRESULT deseja retornado ao chamador.

nID

[no] O identificador de recurso onde é armazenada a seqüência de caracteres de descrição de erro. Esse valor deve estar entre 0x0200 e 0xFFFF, inclusive. Em Depurar compilações, um ASSERT resultará se nID não Índicea uma Cadeia de caracteres válida. Em versão compilações, a Cadeia de caracteres de descrição de erro será definida como "Erro desconhecido".

dwHelpID

[no] O identificador de contexto de ajuda para o erro.

lpszHelpFile

[no] O caminho e o nome do arquivo de ajuda que descreve o erro.

hInst

[no] O identificador para o recurso. Por padrão, esse parâmetro é _Module::GetResourceInstance, onde o Module é a instância global de CComModule ou uma classe derivado dele.

Observações

Configura o interface de IErrorInfo para fornecer informações de erro para clientes do objeto. A Cadeia de caracteres lpszDesc é usado como a descrição de texto do erro. Quando o cliente recebe o hRes que você retornar de AtlReportError, o cliente pode acessar a IErrorInfo estrutura para obter detalhes sobre o erro.

ATL Macros e funções Global

Ver também

MAKE_HRESULT

Index