IXtfConsoleControlClient::GetAllSettings

Returns settings for the current console.

Syntax

HRESULT GetAllSettings(
         XTFCONFIGSETTING **pConfigSettings,
         int *count
)  

Parameters

pConfigSettings
Type: XTFCONFIGSETTING**

A pointer to an array of XTFCONFIGSETTING structures describing the settings.

count
Type: int*

The number of elements in the pConfigSettings array.

Return value

Type: HRESULT

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

Remarks

This function returns all of the configuration settings on the current development console. The configuration settings are retrieved as an array of XTFCONFIGSETTING structures, each of which contains the name and current value of the configuration setting.

You can also use the IXtfConsoleControlClient::GetConfigSettings function to iterate over the configuration settings on the current console and invoke an IXtfConfigSettingsCallback::OnFoundSetting callback function implemented in your app for each configuration setting. For more information about accessing configuration settings using Xbox Tools Framework (XTF), see Configuration (xbconfig.exe) (NDA topic)Authorization required.

Requirements

Header: xtfconsolecontrol.h

Library: xtfconsolecontrol.lib

Supported platforms: Windows (for Xbox console tools)

See also

IXtfConfigSettingsCallback::OnFoundSetting
IXtfConsoleControlClient::GetConfigSettings
IXtfConsoleControlClient
XtfConsoleControl