CComCoClass::Error

Article
03/04/2013

Cette fonction statique a été installé l'interface d' IErrorInfo pour fournir des informations d'erreur au client.

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

Paramètres

lpszDesc
[in] la chaîne décrivant l'erreur.La version Unicode d' Error spécifie qu' lpszDesc est de type LPCOLESTR; la version ANSI spécifie un type d' LPCSTR.
iid
[in] L'IID de l'interface définissant l'erreur ou GUID_NULL (valeur par défaut) si l'erreur est définie par le système d'exploitation.
hRes
[in] HRESULT que vous souhaitez retourné à l'appelant.La valeur par défaut est 0.Pour plus d'informations sur l' hRes, consultez les notes.
nID
[in] L'identificateur de ressource où la chaîne de description d'erreur est signalée.Cette valeur doit reposer entre 0x0200 et 0xFFFF, inclusivement.Dans les versions debug, ASSERT résultera si nID clés ne pas une chaîne valide.Dans les versions release, la chaîne de description de l'erreur sera la valeur « erreur inconnue. »
dwHelpID
[in] l'identificateur de contexte d'aide pour l'erreur.
lpszHelpFile
[in] Le chemin d'accès et le nom du fichier d'aide décrivant l'erreur.
hInst
[in] le handle à la ressource.Par défaut, ce paramètre est _AtlModule::GetResourceInstance, où _AtlModule est l'instance globale de CAtlModule.

Valeur de retour

Une valeur standard d' HRESULT .Pour plus d'informations, consultez les notes.

Notes

Pour appeler Error, votre objet doit implémenter l'interface d' ISupportErrorInfo Interface .

Si le paramètre d' hRes est différent de zéro, tandis Error retourne la valeur d' hRes.Si hRes est zéro, les quatre premières versions du retour DISP_E_EXCEPTIONd' Error .Les deux dernières versions retournent le résultat du MAKE_HRESULT( 1, FACILITY_ITF, nID ).

Configuration requise

Header: atlcom.h

Voir aussi

Référence

Classe de CComCoClass

Classe d'ISupportErrorInfoImpl

MAKE_HRESULT

Partager via