IXtfConsoleManager::AddConsole method

Article
03/16/2023

Adds a development console to the IXtfConsoleManager instance.

Syntax

public:
HRESULT AddConsole(
         LPCWSTR pszAlias,
         LPCWSTR pszAddress,
         XTF_ADD_CONSOLE_FLAGS dwFlags
)

Parameters

pszAlias
Type: LPCWSTR

A pointer to the name of the console to add.

pszAddress
Type: LPCWSTR

A pointer to the Tools IP address of the console to add.

dwFlags
Type: XTF_ADD_CONSOLE_FLAGS

A combination of bitwise-OR flags that specify how to add the console to the instance. The following table describes the available flags.

Value	Macro	Description
0x0	XTF_ADD_CONSOLE_FLAGS_NONE	No flags are specified.
0x1	XTF_ADD_CONSOLE_FLAGS_SETDEFAULT	After the development console is added, set it as the default development console for this PC.

Return value

Type: HRESULT

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

Remarks

This method adds the development console specified in pszAddress, using the name specified in pszAlias, to the IXtfConsoleManager instance. If XTF_ADD_CONSOLE_FLAGS_SETDEFAULT is specified in dwFlags, the development console is also set as the default development console for this PC. For more information about the default development console, see IXtfConsoleManager::SetDefaultConsole Method.

After this method is successfully called, the IXtfConsoleManager instance invokes the OnAddConsole callback method from the associated IXtfConsoleManagerCallback instance. If XTF_ADD_CONSOLE_FLAGS_SETDEFAULT is specified in dwFlags, the OnChangedDefaultConsole callback method from the associated IXtfConsoleManagerCallback instance is also invoked.

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