iConfigFile Struct Reference
[Utilities]
Configuration file interface.
More...
#include <cfgfile.h>
Inheritance diagram for iConfigFile:

Public Methods | |
virtual const char * | GetFileName () const=0 |
Get configuration file name. | |
virtual iVFS * | GetVFS () const=0 |
Get the VFS object on which this file is stored (if any). | |
virtual void | SetFileName (const char *, iVFS *)=0 |
Set config file name. | |
virtual bool | Load (const char *iFileName, iVFS *=0, bool Merge=false, bool NewWins=true)=0 |
Load a configuration file. | |
virtual bool | Save ()=0 |
Save configuration to the same place from which it was loaded. | |
virtual bool | Save (const char *iFileName, iVFS *=0)=0 |
Save configuration into the given file (on VFS or on the physical filesystem). | |
virtual void | Clear ()=0 |
Delete all options and rewind all iterators. | |
virtual csPtr< iConfigIterator > | Enumerate (const char *Subsection=0)=0 |
Enumerate selected keys. | |
virtual bool | KeyExists (const char *Key) const=0 |
Test if a key exists. | |
virtual bool | SubsectionExists (const char *Subsection) const=0 |
Test if at least one key exists with the given Subsection prefix. | |
virtual int | GetInt (const char *Key, int Def=0) const=0 |
Get an integer value from the configuration. | |
virtual float | GetFloat (const char *Key, float Def=0.0) const=0 |
Get a float value from the configuration. | |
virtual const char * | GetStr (const char *Key, const char *Def="") const=0 |
Get a string value from the configuration. | |
virtual bool | GetBool (const char *Key, bool Def=false) const=0 |
Get a boolean value from the configuration. | |
virtual const char * | GetComment (const char *Key) const=0 |
Get the comment of the given key, or 0 if no comment exists. | |
virtual void | SetStr (const char *Key, const char *Val)=0 |
Set an null-terminated string value. | |
virtual void | SetInt (const char *Key, int Value)=0 |
Set an integer value. | |
virtual void | SetFloat (const char *Key, float Value)=0 |
Set a floating-point value. | |
virtual void | SetBool (const char *Key, bool Value)=0 |
Set a boolean value. | |
virtual bool | SetComment (const char *Key, const char *Text)=0 |
Set the comment for given key. | |
virtual void | DeleteKey (const char *Key)=0 |
Delete a key and its value and comment. | |
virtual const char * | GetEOFComment () const=0 |
return the final comment at the end of the configuration file | |
virtual void | SetEOFComment (const char *Text)=0 |
set the final comment at the end of the configuration file |
Detailed Description
Configuration file interface.
Definition at line 35 of file cfgfile.h.
Member Function Documentation
|
Delete all options and rewind all iterators.
Implemented in csConfigFile, and csConfigManager. |
|
Delete a key and its value and comment.
Implemented in csConfigFile, and csConfigManager. |
|
Enumerate selected keys. If a subsection is given, only those keys which are prefixed by the subsection string will be enumerated. The returned iterator does not yet point to a valid key. You must call Next() to set it to the first key. Implemented in csConfigFile, and csConfigManager. |
|
Get a boolean value from the configuration. The optional default value (Def parameter) will be used if the key was not found. Implemented in csConfigFile, and csConfigManager. |
|
Get the comment of the given key, or 0 if no comment exists.
Implemented in csConfigFile, and csConfigManager. |
|
return the final comment at the end of the configuration file
Implemented in csConfigFile, and csConfigManager. |
|
Get configuration file name.
Implemented in csConfigFile, and csConfigManager. |
|
Get a float value from the configuration. The optional default value (Def parameter) will be used if the key was not found. Implemented in csConfigFile, and csConfigManager. |
|
Get an integer value from the configuration. The optional default value (Def parameter) will be used if the key was not found. Implemented in csConfigFile, and csConfigManager. |
|
Get a string value from the configuration. The optional default value (Def parameter) will be used if the key was not found. Implemented in csConfigFile, and csConfigManager. |
|
Get the VFS object on which this file is stored (if any). Returns 0 if this file resides within the real (non-VFS) filesystem. Implemented in csConfigFile, and csConfigManager. |
|
Test if a key exists.
Implemented in csConfigFile, and csConfigManager. |
|
Load a configuration file.
If the file resides in a real filesystem, rather than a VFS filesystem, then pass 0 for the VFS argument. You can set the Merge flag to merge the newly loaded configuration information into the existing information. If you do so, nothing will happen if the named file doesn't exist. The NewWins flag determines the behavior in case of configuration key conflicts. If true, then the new configuration value replaces the old for that key. If false, then the old value is kept, and the new value is ignored. The recorded file name will be set to the name of the newly loaded file if the Merge flag is false; otherwise it will retain the old name. Implemented in csConfigFile, and csConfigManager. |
|
Save configuration into the given file (on VFS or on the physical filesystem). If the second parameter is skipped, the file will be written to the physical filesystem, otherwise it is stored on given VFS filesystem. This method does not change the internally stored file name. Implemented in csConfigFile, and csConfigManager. |
|
Save configuration to the same place from which it was loaded. Returns true if the save operation succeeded. Implemented in csConfigFile, and csConfigManager. |
|
Set a boolean value.
Implemented in csConfigFile, and csConfigManager. |
|
Set the comment for given key. In addition to an actual comment, you can use "" for Text to place an empty comment line before this key, or 0 to remove the comment entirely. The comment may contain newline characters. Returns false if the key does not exist. Implemented in csConfigFile, and csConfigManager. |
|
set the final comment at the end of the configuration file
Implemented in csConfigFile, and csConfigManager. |
|
Set config file name. You can use this if you want Save() to write to another file. This will set the dirty flag. Implemented in csConfigFile, and csConfigManager. |
|
Set a floating-point value.
Implemented in csConfigFile, and csConfigManager. |
|
Set an integer value.
Implemented in csConfigFile, and csConfigManager. |
|
Set an null-terminated string value.
Implemented in csConfigFile, and csConfigManager. |
|
Test if at least one key exists with the given Subsection prefix.
Implemented in csConfigFile, and csConfigManager. |
The documentation for this struct was generated from the following file:
- iutil/cfgfile.h
Generated for Crystal Space by doxygen 1.2.18