XtfGetErrorTextA
Obtém uma mensagem de erro amigável e o texto de ação do usuário para oHRESULT especificado.
Sintaxe
Parâmetros
HResultTipo: HRESULT [in] O
HRESULT para o qual pesquisar a mensagem de erro e o texto de ação do usuário.
errorMessageBufferTipo: PSTR* [out] Um ponteiro para o buffer que recebe a mensagem de erro como uma cadeia de caracteres terminada em nulo. Para determinar o comprimento de buffer necessário, defina esse parâmetro como
nullptr e o parâmetro errorMessageBufferLength como 0. Após a invocação, errorMessageBufferLength é definido como o comprimento do buffer necessário em CHARs, incluindo o caractere nulo de terminação.
errorMessageBufferLengthTipo: UINT32* [in, out] Na entrada, o comprimento do buffer de mensagem de erro em CHARs. O comprimento do buffer deve incluir espaço para um caractere nulo de terminação. Na saída, o comprimento necessário de errorMessageBuffer em CHARs userActionTextBuffer
Tipo: PSTR* [out] Um ponteiro para o buffer que recebe o texto de ação do usuário como uma cadeia de caracteres terminada em nulo. Para determinar o comprimento de buffer necessário, defina esse parâmetro como
nullptr e o parâmetro userActionTextBufferLength como 0. Após a invocação, userActionTextBufferLength é definido como o comprimento do buffer necessário em CHARs, incluindo o caractere nulo de terminação.
userActionTextBufferLengthTipo: UINT32* [in, out] O comprimento do buffer de texto de ação do usuário em CHARs. O comprimento do buffer deve incluir espaço para um caractere nulo de terminação.
Valor retornado
Tipo: HRESULT RetornaS_OK se for bem-sucedido; caso contrário, retorna um código de erro HRESULT.
Se S_OK for retornado, a função foi bem-sucedida. errorMessageBuffer e userActionTextBuffer são definidos como a mensagem de erro e o texto de ação do usuário, respectivamente, para o HRESULT especificado.
Se HRESULT_FROM_WIN32(ERROR_MORE_DATA) for retornado, o buffer fornecido para errorMessageBuffer ou userActionTextBuffer não era grande o suficiente. errorMessageBufferLength e userActionTextBufferLength são definidos como os comprimentos de buffer necessários da mensagem de erro e do texto de ação do usuário, respectivamente, para o HRESULT especificado.
Se qualquer outro código HRESULT for retornado, ocorreu um erro inesperado.
Comentários
Se oHRESULT passado para XtfGetErrorText não for um código de erro reconhecido do XBOX Tools Framework (XTF), errorMessageBuffer será definido como “Unspecified error”. Você pode usar esse resultado para verificar se o HRESULT especificado é um código de erro do XTF reconhecido. Para obter mais informações sobre os códigos de erro do XTF reconhecidos, confira Erros de transporte do XTF (tópico NDA).
Requisitos
Cabeçalho: xtfapi.h Biblioteca: XtfApi.lib Plataformas com suporte: Windows (para ferramentas de console XBOX)Confira também
XtfConsoleControlReferência da API nativa do XBOX Tools Framework