Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Causes all configuration settings to be enumerated, invoking a callback for each configuration setting.
Syntax
HRESULT GetConfigSettings(
IXtfConfigSettingsCallback *pCallback
)
Parameters
pCallback
Type: IXtfConfigSettingsCallback*
A pointer to an instance of the IXtfConfigSettingsCallback interface, to be invoked as each configuration setting is enumerated.
Return value
Type: HRESULT
Returns S_OK if successful; otherwise, returns an HRESULT error code.
Remarks
This function causes the Xbox Tools Framework (XTF) API to enumerate all of the configuration settings on the current development console. When a configuration setting is found, the XTF API invokes the OnFoundSetting callback function from the IXtfConfigSettingsCallback interface implemented in your app and specified in pCallback. The XTF API passes a pointer to an XTFCONFIGSETTING structure, describing the configuration setting, when it invokes your implemented OnFoundSetting function.
Note
Memory for the XTFCONFIGSETTING structure is owned by the Xbox Tools Framework (XTF) API and is invalidated after each invocation of your IXtfConfigSettingsCallback::OnFoundSetting callback function. You must copy the information in the structure if you need it for later use.
You can also use the IXtfConsoleControlClient::GetAllSettings method to return an array of XTFCONFIGSETTING structures for all configuration settings on the current development console.
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::GetAllSettings
IXtfConsoleControlClient
XtfConsoleControl