Skip to main content

XtfGetErrorTextA

获取指定 HRESULT 的用户友好错误消息和用户操作文本。

语法

参数

HResult
类型:HRESULT
[in] 用于查找错误消息和用户操作文本的 HRESULT errorMessageBuffer
类型:PSTR*
[out] 指向接收错误消息(以 null 结尾的字符串形式)的缓冲区的指针。若要确定所需的缓冲区长度,请将此参数设置为 nullptr,并将 errorMessageBufferLength 参数设置为 0。调用时,errorMessageBufferLength 会被设置为所需缓冲区的长度(以 CHAR 为单位),包括终止 null 字符。 errorMessageBufferLength
类型:UINT32*
[in, out] 输入时为错误消息缓冲区的长度(以 CHAR 为单位)。缓冲区长度必须包含用于终止 null 字符的空间。输出时为 errorMessageBuffer 的所需长度(以 CHAR 为单位)。 userActionTextBuffer
类型:PSTR*
[out] 指向接收用户操作文本(以 null 结尾的字符串形式)的缓冲区的指针。若要确定所需的缓冲区长度,请将此参数设置为 nullptr,并将 userActionTextBufferLength 参数设置为 0。调用时,userActionTextBufferLength 会被设置为所需缓冲区的长度(以 CHAR 为单位),包括终止 null 字符。 userActionTextBufferLength
类型:UINT32*
[in, out] 用户操作文本缓冲区的长度(以 CHAR 为单位)。缓冲区长度必须包含用于终止 null 字符的空间。

返回值

类型:HRESULT 如果成功,则返回 S_OK;否则返回 HRESULT 错误代码。 如果返回 S_OK,表示函数成功。errorMessageBufferuserActionTextBuffer 分别被设置为指定 HRESULT 的错误消息和用户操作文本。 如果返回 HRESULT_FROM_WIN32(ERROR_MORE_DATA),则表示为 errorMessageBufferuserActionTextBuffer 提供的缓冲区不够大。errorMessageBufferLengthuserActionTextBufferLength 分别被设置为指定 HRESULT 的错误消息和用户操作文本所需的缓冲区长度。 如果返回任何其他 HRESULT 代码,则表示发生了意外错误。

备注

如果传递给 XtfGetErrorTextHRESULT 不是可识别的 XBOX Tools Framework (XTF) 错误代码,errorMessageBuffer 将被设置为 “Unspecified error”。你可以使用此结果来检查指定的 HRESULT 是否为可识别的 XTF 错误代码。有关可识别的 XTF 错误代码的详细信息,请参阅 XTF 传输错误 (NDA 主题)

要求

头文件: xtfapi.h 库: XtfApi.lib 支持的平台: Windows(适用于 XBOX 主机工具)

另请参阅

XtfConsoleControl
XBOX Tools Framework 原生 API 参考
最后修改于 2026年8月24日