CComCoClass::erro

Artigo
08/25/2010

Esta função estática configura o IErrorInfo interface 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 seqüência de caracteres descrevendo o erro.A versão Unicode de Error Especifica que lpszDesc é do tipo LPCOLESTR; o ANSI versão Especifica um tipo de LPCSTR.
iid
[in] O IID da interface definindo o erro ou GUID_NULL (o valor padrão) se o erro é definido pelo sistema operacional.
hRes
[in] The HRESULT você deseja que seja retornada ao chamador. O valor padrão é 0.Para obter mais detalhes sobre hRes, consulte comentários.
nID
[in] O identificador de recurso onde a seqüência de caracteres de descrição do erro está armazenada.Esse valor deve estar entre 0x0200 e 0xFFFF, inclusive.Em compilações de depurar, um DECLARAR resultará se nID não indexa uma cadeia de caracteres válida. Nas compilações lançadas, a seqüência de caracteres de descrição de erro será definida como "Erro desconhecido".
dwHelpID
[in] O identificador de contexto de ajuda para o erro.
lpszHelpFile
[in] O caminho e o nome do arquivo de Ajuda descrevendo o erro.
hInst
[in] O identificador para o recurso.Por padrão, este parâmetro é _AtlModule::GetResourceInstance, where _AtlModule é a instância global da CAtlModule.

Valor de retorno

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

Comentários

To telefonar Error, o objeto deve implementar o ISupportErrorInfo Interface interface.

Se o hRes o parâmetro é diferente de zero, em seguida Error Retorna o valor de hRes. If hRes for zero, as quatro primeiras versões do Error retornar DISP_E_EXCEPTION. As duas últimas versões retornam o resultado da macro MAKE_HRESULT FACILITY_ITF, (1, nID ).