IXtfConsoleControlClient::GetConfigValue
Gets the value of the specified configuration setting.Syntax
Parameters
pszKeyType: LPCWSTR A pointer to the name of the configuration setting to get the value of. pszValue
Type: LPBSTR The pointer that receives the value of the configuration setting specified in pszKey.
Return value
Type: HRESULT ReturnsS_OK if successful; otherwise, returns an HRESULT error code.
Remarks
This function returns the value of a single configuration setting from the current development console. IfpszKey is set to the pointer of a string that contains a valid name (or key) of a configuration setting, the function returns S_OK and sets pszValue to the pointer of a string that contains the value of that configuration setting. Otherwise, the function returns an error.
If you want to enumerate each configuration setting on the current console, you can use the IXtfConsoleControlClient::GetConfigSettings function to iterate over the configuration settings and invoke an IXtfConfigSettingsCallback::OnFoundSetting callback function, implemented in your app, for each configuration setting. 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).
Handling LPBSTR pointers
For more information about handling LPBSTR pointers returned by this function, see Allocating and Releasing Memory for a BSTR.Requirements
Header: xtfconsolecontrol.h Library: xtfconsolecontrol.lib Supported platforms: Windows (for XBOX console tools)See also
IXtfConsoleControlClientXtfConsoleControl