XtfGetConsoleInfoList
Returns anXtfConsoleInfo object that contains information about a console.
Syntax
Parameters
addressType: PCWSTR [in] The address of the console. hConsoleInfo
Type: XtfConsoleInfo* [out] A pointer to be used with the XtfGetConsoleFieldValue function to retrieve information about a console.
Return value
Type: HRESULT ReturnsS_OK if the function succeeded and XtfGetConsoleFieldValue can be used to retrieve values from hConsoleInfo; otherwise, returns an HRESULT error code.
Remarks
To retrieve information about a console, first use this function to get anXtfConsoleInfo pointer, and then use XtfGetConsoleFieldValue to retrieve information about the console from that pointer. After you retrieve the information you need, use XtfCloseConsoleInfoList to free resources associated with the returned XtfConsoleInfo pointer.
XtfGetConsoleInfoList retrieves all of the information from the console and provides a pointer to that information. XtfGetConsoleFieldValue only iterates that retrieved information. You must use both functions together to retrieve information about a console.If the target console specified in
address for this function has not been provisioned, the XtfGetConsoleFieldValue function returns an empty value if XtfConsoleFieldId::DeviceID is specified in field.XtfGetConsoleInfoList and XtfGetConsoleFieldValue functions together to retrieve the console ID of a development console.
Requirements
Header: xtfapi.h Library: XtfApi.lib Supported platforms: Windows (for XBOX console tools)See also
XtfConsoleControlXBOX Tools Framework
