iConfigIterator Struct Reference
[Utilities]
Iterator which allows sequential access to configuration information contained in an iConfigFile object.
More...
#include <cfgfile.h>
Inheritance diagram for iConfigIterator:

Public Methods | |
virtual iConfigFile * | GetConfigFile () const=0 |
Returns the configuration object for this iterator. | |
virtual const char * | GetSubsection () const=0 |
Returns the subsection in the configuruation. | |
virtual void | Rewind ()=0 |
Rewind the iterator (points to nowhere after this). | |
virtual bool | Next ()=0 |
Move to the next valid key. Returns false if no more keys exist. | |
virtual const char * | GetKey (bool Local=false) const=0 |
Get the current key name. | |
virtual int | GetInt () const=0 |
Get an integer value from the configuration. | |
virtual float | GetFloat () const=0 |
Get a float value from the configuration. | |
virtual const char * | GetStr () const=0 |
Get a string value from the configuration. | |
virtual bool | GetBool () const=0 |
Get a boolean value from the configuration. | |
virtual const char * | GetComment () const=0 |
Get the comment of the given key, or 0 if no comment exists. |
Detailed Description
Iterator which allows sequential access to configuration information contained in an iConfigFile object.
Definition at line 153 of file cfgfile.h.
Member Function Documentation
|
Get a boolean value from the configuration.
Implemented in csWin32RegistryIterator. |
|
Get the comment of the given key, or 0 if no comment exists.
Implemented in csWin32RegistryIterator. |
|
Returns the configuration object for this iterator.
Implemented in csWin32RegistryIterator. |
|
Get a float value from the configuration.
Implemented in csWin32RegistryIterator. |
|
Get an integer value from the configuration.
Implemented in csWin32RegistryIterator. |
|
Get the current key name. Set Local to true to return only the local name inside the iterated subsection. This is the portion of the key string which follows the subsection prefix which was used to create this iterator. Implemented in csWin32RegistryIterator. |
|
Get a string value from the configuration.
Implemented in csWin32RegistryIterator. |
|
Returns the subsection in the configuruation.
Implemented in csWin32RegistryIterator. |
|
Move to the next valid key. Returns false if no more keys exist.
Implemented in csWin32RegistryIterator. |
|
Rewind the iterator (points to nowhere after this).
Implemented in csWin32RegistryIterator. |
The documentation for this struct was generated from the following file:
- iutil/cfgfile.h
Generated for Crystal Space by doxygen 1.2.18