mi::rswservices::IUser_configuration Class Reference
[Configuration]
Description
User configuration.
Public Member Functions
- virtual const char* get_name() const =0
- Returns the name of this configuration item. More...
- virtual const IUser_configuration* get_subitem( mi::Uint32 index) const =0
- Returns sub items by index. More...
- virtual const IUser_configuration* get_subitem( const char* name) const =0
- Returns sub items by name. More...
- virtual mi::Uint32 get_subitem_count() const =0
- Returns the number of sub configuration items.
- virtual const char* get_value() const =0
- Returns the value of this configuration item.
Member Functions
- virtual const char* mi::rswservices::IUser_configuration::get_name() const [pure virtual]
-
Returns the name of this configuration item. Will be "user" for the configuration retrieved from IConfiguration and the name of the directive for sub items.
- virtual const IUser_configuration* mi::rswservices::IUser_configuration::get_subitem( mi::Uint32 index) const [pure virtual]
-
Returns sub items by index.
Parameters
- index
- the index of the item
Returns
the configuration item or NULL if index is greater than the number of sub items
- virtual const IUser_configuration* mi::rswservices::IUser_configuration::get_subitem( const char* name) const [pure virtual]
-
Returns sub items by name. Note that there may be more than one configuration item called name, this method will always return the same item. Use get_subitem(index) to fetch multiple items with the same name.
Parameters
- name
- the name of the sub item
Returns
the configuration item or NULL if none stored as name
- virtual mi::Uint32 mi::rswservices::IUser_configuration::get_subitem_count() const [pure virtual]
-
Returns the number of sub configuration items.
- virtual const char* mi::rswservices::IUser_configuration::get_value() const [pure virtual]
-
Returns the value of this configuration item.