IXtfConsoleManager::GetConsole Method

Article
06/22/2023

Gets information about a development console with the specified name from the IXtfConsoleManager instance.

Syntax

public:
HRESULT GetConsole(
         LPCWSTR pszAlias,
         PXTFCONSOLEDATA pConsoleData
)

Parameters

pszAlias
Type: LPCWSTR

A pointer to the name of the console to get information about.

pConsoleData
Type: PXTFCONSOLEDATA

A pointer that receives an XTFCONSOLEDATA structure, which contains information about the development console.

Return value

Type: HRESULT

Returns S_OK if successful; otherwise, returns an HRESULT error code.

Remarks

This method gets information about the development console with the name specified in pszAlias from the IXtfConsoleManager instance. The information is returned in pConsoleData as an XTFCONSOLEDATA structure containing the name and Tools IP address of the specified console.

For more information about connecting and querying development consoles, see Connect (xbconnect.exe) (NDA topic)Autorisation obligatoire.

Requirements

Header: xtfconsolemanager.h

Library: xtfconsolemanager.lib

Supported platforms: Windows (for Xbox console tools)

Partager via