Share via


IXtfConfigSettingsCallback::OnFoundSetting

Callback function called when a configuration setting is being reported.

Syntax

HRESULT OnFoundSetting(
         const PXTFCONFIGSETTING pSetting
)  

Parameters

pSetting
Type: PXTFCONFIGSETTING

A pointer to an XTFCONFIGSETTING structure describing a configuration setting.

Return value

Type: HRESULT

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

Remarks

This callback function is invoked by IXtfConsoleControlClient::GetConfigSettings for each configuration setting found on the development console. This function receives a pointer to an XTFCONFIGSETTING structure that contains the name and value of a configuration setting. For more information about accessing configuration settings using Xbox Tools Framework (XTF), see Configuration (xbconfig.exe) (NDA topic)Authorization required.

Note

Memory for the XTFCONFIGSETTING structure is owned by the Xbox Tools Framework (XTF) API and is invalidated after each invocation of this callback function. You must copy the information in the structure if you need it for later use.

Requirements

Header: xtfconsolecontrol.h

Library: xtfconsolecontrol.lib

Supported platforms: Windows (for Xbox console tools)

See also

IXtfConfigSettingsCallback
XtfConsoleControl
Xbox Tools Framework native API reference