Partager via


XtfCreateConsoleControlClient

Initializes a new instance of the IXtfConsoleControlClient interface with the specified address.

Syntax

HRESULT XtfCreateConsoleControlClient(
         LPCWSTR pszAddress,
         REFIID riid,
         void **ppvObject
)  

Parameters

pszAddress
Type: LPCWSTR

A pointer to the tools IP address of the development console to use for the new IXtfConsoleControlClient instance.

riid
Type: REFIID

The pointer to receive the instance identifier of the newly created IXtfConsoleControlClient instance.

ppvObject
Type: void**

The pointer to receive a reference to the newly created IXtfConsoleControlClient instance.

Return value

Type: HRESULT

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

Remarks

This function creates and attaches a new instance of IXtfConsoleControlClient to the console specified in pszAddress. You can then use the new IXtfConsoleControlClient instance to retrieve information, such as configuration settings, system time, or currently running processes, from the console. You can also set configuration values, generate stack dumps, or shut down the console.

For more information about available tool and automation APIs, such as Xbox Tools Framework (XTF), see Tool and automation APIs (NDA topic)Autorisation obligatoire.

Requirements

Header: xtfconsolecontrol.h

Library: xtfconsolecontrol.lib

Supported platforms: Windows (for Xbox console tools)

See also

XtfConsoleControl
Xbox Tools Framework