Skip to main content

XtfGetConsoleInfoList

返回包含主机相关信息的 XtfConsoleInfo 对象。

语法

参数

address
类型:PCWSTR
[in] 主机的地址。 hConsoleInfo
类型:XtfConsoleInfo*
[out] 与 XtfGetConsoleFieldValue 函数一起使用以检索主机相关信息的指针。

返回值

类型:HRESULT 如果函数成功且可以使用 XtfGetConsoleFieldValuehConsoleInfo 检索值,则返回 S_OK;否则返回 HRESULT 错误代码。

备注

若要检索主机相关信息,请先使用此函数获取 XtfConsoleInfo 指针,然后使用 XtfGetConsoleFieldValue 从该指针中检索主机相关信息。检索所需信息后,请使用 XtfCloseConsoleInfoList 来释放与返回的 XtfConsoleInfo 指针关联的资源。
XtfGetConsoleInfoList 从主机检索所有信息,并提供指向该信息的指针。XtfGetConsoleFieldValue 仅迭代该检索到的信息。你必须同时使用这两个函数才能检索主机相关信息。
如果此函数的 address 中指定的目标主机尚未预配,那么当 field 中指定了 XtfConsoleFieldId::DeviceID 时,XtfGetConsoleFieldValue 函数会返回空值。
以下代码示例演示如何同时使用 XtfGetConsoleInfoListXtfGetConsoleFieldValue 函数来检索开发主机的主机 ID。

要求

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

另请参阅

XtfConsoleControl
XBOX Tools Framework
最后修改于 2026年8月24日