WPRCFormatError
WPRCFormatError
est une fonction conçue pour les messages d’erreur de format en fonction des codes d’erreur HRESULT. Elle permet de récupérer les messages d’erreur.
Syntaxe
HRESULT WPRCFormatError(
_In_ HRESULT Hresult,
_In_opt_ LPUNKNOWN pUnknown,
_Out_ BSTR* pbstrMessage,
_Out_opt_ BSTR* pbstrDescription,
_Out_opt_ BSTR* pbstrDetailedDescription
);
Paramètres
Hresult
(_In_ HRESULT)
: code d’erreur HRESULT qui doit être mis en forme. Ce paramètre est obligatoire.
pUnknown
(_In_opt_ LPUNKNOWN)
: pointeur d’interface facultatif qui peut fournir un contexte supplémentaire pour la mise en forme de l’erreur. Il peut s’agir de NULL
s’il n’est pas utilisé.
pbstrMessage
(_Out_ BSTR*)
: pointeur vers une chaîne BSTR
qui recevra le message d’erreur principal. Ce paramètre de sortie est obligatoire.
pbstrDescription
(_Out_opt_ BSTR*)
: pointeur facultatif vers une chaîne BSTR
qui recevra une description plus détaillée de l’erreur. Il peut s’agir de NULL
s’il n’est pas nécessaire.
pbstrDetailedDescription
(_Out_opt_ BSTR*)
: pointeur facultatif vers une chaîne BSTR
qui recevra une description encore plus détaillée de l’erreur. Il peut également s’agir de NULL
s’il n’est pas nécessaire.
Valeur de retour
La fonction renvoie un code HRESULT. Une exécution réussie est généralement indiquée par S_OK. L’échec est indiqué par un autre code HRESULT, ce qui indique qu’une erreur s’est produite pendant l’exécution de la fonction.