IXtfConsoleManager::SetDefaultConsole Method

Sets the default development console for Xbox Tools Framework (XTF) tools and API.

Syntax

public:
HRESULT SetDefaultConsole(
         LPCWSTR pszAlias
)  

Parameters

pszAlias
Type: LPCWSTR

A pointer to the name of the development console to set as the default development console.

Return value

Type: HRESULT

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

Remarks

This method sets the development console with the alias specified in pszAlias from the IXtfConsoleManager instance as the default development console to use with Xbox Tools Framework (XTF) tools and API on this PC.

After this method is successfully called, the IXtfConsoleManager instance invokes the OnChangedDefaultConsole callback method from the associated IXtfConsoleManagerCallback instance.

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

Requirements

Header: xtfconsolemanager.h

Library: xtfconsolemanager.lib

Supported platforms: Windows (for Xbox console tools)

See also

IXtfConsoleManager Interface
XtfConsoleManager