XtfGetErrorTextA
Obtient un message d’erreur convivial et un texte d’action utilisateur pour leHRESULT spécifié.
Syntaxe
Paramètres
HResultType : HRESULT [in]
HRESULT pour lequel rechercher le message d’erreur et le texte d’action utilisateur.
errorMessageBufferType : PSTR* [out] Pointeur vers la mémoire tampon qui reçoit le message d’erreur sous forme de chaîne terminée par un caractère null. Pour déterminer la longueur de mémoire tampon requise, définissez ce paramètre à
nullptr et le paramètre errorMessageBufferLength à 0. Lors de l’appel, errorMessageBufferLength est défini à la longueur de la mémoire tampon requise en CHAR, y compris le caractère null de fin.
errorMessageBufferLengthType : UINT32* [in, out] En entrée, longueur de la mémoire tampon du message d’erreur en CHAR. La longueur de la mémoire tampon doit inclure de l’espace pour un caractère null de fin. En sortie, longueur requise de errorMessageBuffer en CHAR userActionTextBuffer
Type : PSTR* [out] Pointeur vers la mémoire tampon qui reçoit le texte d’action utilisateur sous forme de chaîne terminée par un caractère null. Pour déterminer la longueur de mémoire tampon requise, définissez ce paramètre à
nullptr et le paramètre userActionTextBufferLength à 0. Lors de l’appel, userActionTextBufferLength est défini à la longueur de la mémoire tampon requise en CHAR, y compris le caractère null de fin.
userActionTextBufferLengthType : UINT32* [in, out] Longueur de la mémoire tampon du texte d’action utilisateur en CHAR. La longueur de la mémoire tampon doit inclure de l’espace pour un caractère null de fin.
Valeur de retour
Type : HRESULT RetourneS_OK en cas de réussite; sinon, retourne un code d’erreur HRESULT.
Si S_OK est retourné, la fonction a réussi. errorMessageBuffer et userActionTextBuffer sont définis respectivement au message d’erreur et au texte d’action utilisateur pour le HRESULT spécifié.
Si HRESULT_FROM_WIN32(ERROR_MORE_DATA) est retourné, la mémoire tampon fournie pour errorMessageBuffer ou userActionTextBuffer n’était pas assez grande. errorMessageBufferLength et userActionTextBufferLength sont définis respectivement aux longueurs de mémoire tampon requises du message d’erreur et du texte d’action utilisateur pour le HRESULT spécifié.
Si tout autre code HRESULT est retourné, une erreur inattendue s’est produite.
Remarques
Si leHRESULT passé à XtfGetErrorText n’est pas un code d’erreur XBOX Tools Framework (XTF) reconnu, errorMessageBuffer est défini à “Unspecified error”. Vous pouvez utiliser ce résultat pour vérifier si le HRESULT spécifié est un code d’erreur XTF reconnu. Pour plus d’informations sur les codes d’erreur XTF reconnus, consultez Erreurs de transport XTF (rubrique sous NDA).
Configuration requise
En-tête : xtfapi.h Bibliothèque : XtfApi.lib Plateformes prises en charge : Windows (pour les outils de console XBOX)Voir aussi
XtfConsoleControlRéférence de l’API native XBOX Tools Framework