通过

XtfGetErrorText

  • 项目

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

语法

HRESULT XtfGetErrorText(
         HRESULT HResult,
         PWSTR *errorMessageBuffer,
         UINT32 *errorMessageBufferLength,
         PWSTR *userActionTextBuffer,
         UINT32 *userActionTextBufferLength
)

参数

HResult
类型：HRESULT

[in] 要为其查找错误消息和用户操作文本的 HRESULT。

errorMessageBuffer
类型：PWSTR*

[out] 指向一个缓冲区的指针，该缓冲区接收作为 null 终止字符串的错误消息。 要确定所需的缓冲区长度，请将此参数设置为 nullptr 并将 errorMessageBufferLength 参数设置为 0。 调用时，errorMessageBufferLength 设置为包括终止 null 字符在内的所需的缓冲区长度 (WCHAR)。

errorMessageBufferLength
类型：UINT32*

[in, out] 输入时错误消息缓冲区的长度 (WCHAR)。 缓冲区长度必须包括终止 null 字符占用的空间。 输出时所需的 errorMessageBuffer 长度 (WCHAR)

userActionTextBuffer
类型：PWSTR*

[out] 指向一个缓冲区的指针，该缓冲区接收作为 null 终止字符串的用户操作文本。 要确定所需的缓冲区长度，请将此参数设置为 nullptr 并将 userActionTextBufferLength 参数设置为 0。 调用时，userActionTextBufferLength 设置为包括终止 null 字符在内的所需的缓冲区长度 (WCHAR)。

userActionTextBufferLength
类型：UINT32*

[in, out] 用户操作文本缓冲区的长度（类型为 WCHAR）。 缓冲区长度必须包括终止 null 字符占用的空间。

返回值

类型：HRESULT

如果成功，则返回 S_OK；否则返回 HRESULT 错误代码。

如果返回 S_OK，则函数成功。 对于指定的 HRESULT，errorMessageBuffer 和 userActionTextBuffer 分别设置为错误消息和用户操作文本。

如果返回 HRESULT_FROM_WIN32(ERROR_MORE_DATA)，则表明为 errorMessageBuffer 或 userActionTextBuffer 提供的缓冲区不够大。 对于指定的 HRESULT，将 errorMessageBufferLength 和 userActionTextBufferLength 分别设置为错误消息和用户操作文本的所需缓冲区长度。

如果返回任何其他 HRESULT 代码，则出现意外错误。

备注

如果传递给 XtfGetErrorText 的 HRESULT 不是可识别的 Xbox 工具框架 (XTF) 错误代码，则 errorMessageBuffer 设置为“未指定的错误”。 可以使用此结果来检查指定的 HRESULT 是否为可识别的 XTF 错误代码。 有关识别的 XTF 错误代码的详细信息，请参阅 XTF 传输错误（NDA 主题）。

要求

头文件：xtfapi.h

库：XtfApi.lib

支持平台：Windows（适用于 Xbox 主机工具）

另请参阅

XtfConsoleControl
Xbox 工具框架本机 API 参考