Public API Reference

                 

---

iConfig Struct Reference
[Utilities]

Interface to a configurator object. More...

#include <config.h>

Inheritance diagram for iConfig:

List of all members.

Public Methods
virtual bool	GetOptionDescription (int idx, csOptionDescription *option)=0
	Get option description; return FALSE if there is no such option.
virtual bool	SetOption (int id, csVariant *value)=0
	Set option.
virtual bool	GetOption (int id, csVariant *value)=0
	Get option.

---

Detailed Description

Interface to a configurator object.

If a SCF module has an object implementing this interface then this can be used to query/set configuration options.

Main creators of instances implementing this interface:

• Some plugins implement this.

Main ways to get pointers to this interface:

• SCF_QUERY_INTERFACE() from a plugin instance.

Main users of this interface:

• csCommandLineHelper
• csPluginManager

Definition at line 163 of file config.h.

---

Member Function Documentation

virtual bool iConfig::GetOption (  int    id, csVariant *    value )  [pure virtual]

Get option.

virtual bool iConfig::GetOptionDescription (  int    idx, csOptionDescription *    option )  [pure virtual]

Get option description; return FALSE if there is no such option.

virtual bool iConfig::SetOption (  int    id, csVariant *    value )  [pure virtual]

Set option.

---

The documentation for this struct was generated from the following file:

• iutil/config.h

---