XtfGetErrorTextA
Obtiene un mensaje de error descriptivo y el texto de acción del usuario para elHRESULT especificado.
Sintaxis
Parámetros
HResultTipo: HRESULT [in] El
HRESULT para el que se buscan el mensaje de error y el texto de acción del usuario.
errorMessageBufferTipo: PSTR* [out] Un puntero al búfer que recibe el mensaje de error como una cadena terminada en null. Para determinar la longitud de búfer necesaria, establezca este parámetro en
nullptr y el parámetro errorMessageBufferLength en 0. Tras la invocación, errorMessageBufferLength se establece en la longitud del búfer necesario en CHAR, incluido el carácter null de terminación.
errorMessageBufferLengthTipo: UINT32* [in, out] En la entrada, la longitud del búfer del mensaje de error en CHAR. La longitud del búfer debe incluir espacio para un carácter null de terminación. En la salida, la longitud necesaria de errorMessageBuffer en CHAR userActionTextBuffer
Tipo: PSTR* [out] Un puntero al búfer que recibe el texto de acción del usuario como una cadena terminada en null. Para determinar la longitud de búfer necesaria, establezca este parámetro en
nullptr y el parámetro userActionTextBufferLength en 0. Tras la invocación, userActionTextBufferLength se establece en la longitud del búfer necesario en CHAR, incluido el carácter null de terminación.
userActionTextBufferLengthTipo: UINT32* [in, out] La longitud del búfer del texto de acción del usuario en CHAR. La longitud del búfer debe incluir espacio para un carácter null de terminación.
Valor devuelto
Tipo: HRESULT DevuelveS_OK si se ejecuta correctamente; de lo contrario, devuelve un código de error HRESULT.
Si se devuelve S_OK, la función se ejecutó correctamente. errorMessageBuffer y userActionTextBuffer se establecen en el mensaje de error y el texto de acción del usuario, respectivamente, para el HRESULT especificado.
Si se devuelve HRESULT_FROM_WIN32(ERROR_MORE_DATA), el búfer proporcionado para errorMessageBuffer o userActionTextBuffer no era lo suficientemente grande. errorMessageBufferLength y userActionTextBufferLength se establecen en las longitudes de búfer necesarias para el mensaje de error y el texto de acción del usuario, respectivamente, para el HRESULT especificado.
Si se devuelve cualquier otro código HRESULT, se produjo un error inesperado.
Comentarios
Si elHRESULT pasado a XtfGetErrorText no es un código de error reconocido de XBOX Tools Framework (XTF), errorMessageBuffer se establece en “Unspecified error”. Puede usar este resultado para comprobar si el HRESULT especificado es un código de error XTF reconocido. Para obtener más información sobre los códigos de error XTF reconocidos, consulte Errores de transporte de XTF (tema NDA).
Requisitos
Encabezado: xtfapi.h Biblioteca: XtfApi.lib Plataformas compatibles: Windows (para herramientas de consola XBOX)Consulte también
XtfConsoleControlReferencia de la API nativa de XBOX Tools Framework