ISettingsNamespace::GetSettingByPath method (wcmconfig.h)

  • 2 minutes to read

Gets the setting object specified by a path.

Syntax

HRESULT GetSettingByPath(
  const WCHAR   *Path,
  ISettingsItem **Setting
);

Parameters

Path

The path of the object.

Setting

A pointer to an ISettingsItem object that represents the retrieved object.

Return value

This method can return one of these values.

Return code Description
S_OK
 Indicates success.
WCM_E_STATENODENOTFOUND
 Indicates an attempt to get an item that does not exist.
WCM_E_INVALIDPATH
 Indicates that the path is not formatted correctly.
WCM_E_INVALIDKEY
 Indicates that the path contains an unrecognized XML escape sequence.
WCM_E_WRONGESCAPESTRING
 Indicates that the path is incorrectly specified and references the wrong key for a list item.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wcmconfig.h
DLL SMIEngine.dll

See also

ISettingsNamespace