PPL6-Icon Patrick's Programming Library Version 6.4.21 - Dokumentation
ppl6::CConfig Klassenreferenz

Klasse zum Verarbeiten von Config-Files. Mehr ...

Öffentliche Methoden

 CConfig ()
 
 CConfig (const char *filename)
 
 CConfig (CFileObject *file)
 
 ~CConfig ()
 
int Add (const char *section, const char *key, const char *value)
 
int Add (const char *key, const char *value)
 
int Add (const char *key, int value)
 
int Add (const char *section, const char *key, int value)
 
int Add (const char *section, const char *key, bool value)
 
int CreateSection (const char *section)
 
int Delete (const char *key)
 
int Delete (const char *section, const char *key)
 
int DeleteSection (const char *section)
 
int FirstSection ()
 
const char * Get (const char *key, const char *defaultvalue=NULL)
 
const char * Get (const char *section, const char *key, const char *defaultvalue=NULL)
 
bool GetBool (const char *section, const char *key, bool defaultvalue=false)
 
bool GetBool (const char *key, bool defaultvalue=false)
 
int GetFirst (char **key, char **value)
 
int GetFirst (CString *key, CString *value)
 
int GetInt (const char *section, const char *key, int defaultvalue=0)
 
int GetInt (const char *key, int defaultvalue=0)
 
int GetNext (char **key, char **value)
 
int GetNext (CString *key, CString *value)
 
const char * GetSection (const char *section)
 Inhalt einer Sektion als char* auslesen. Mehr ...
 
const char * GetSectionName ()
 
int IsTrue (const char *value)
 
int Load (const char *filename,...)
 Konfiguration aus einer Datei laden. Mehr ...
 
int Load (CFileObject *file)
 Konfiguration aus einem CFileObject-Objekt laden. Mehr ...
 
int LoadFromMemory (void *buffer, int bytes)
 Konfiguration aus dem Speicher laden. Mehr ...
 
int LoadFromString (CString &string)
 Konfiguration aus einem String laden. Mehr ...
 
int NextSection ()
 
void Print ()
 Konfiguration auf STDOUT ausgeben. Mehr ...
 
CAssocArrayReadSection (const char *section, CAssocArray *a=NULL)
 Inhalt einer Sektion ein einem Array speichern. Mehr ...
 
void Reset ()
 
int Save (const char *filename)
 
int Save (CFileObject *file)
 
int SelectSection (const char *section)
 
void SetSeparator (const char *string)
 
int String2Point (const char *string, POINT *p)
 
void String2Rect (const char *string, RECT *r)
 
void Unload ()
 

Private Methoden

void * FindSection (const char *sectionname)
 
void Init ()
 

Private Attribute

char * currentsection
 
void * first
 
bool isused
 
void * last
 
void * section
 
CAssocArray sections
 
char * separator
 
size_t separatorLength
 

Ausführliche Beschreibung

Include:
#include <ppl6.h>
Beschreibung:
Mit dieser Klasse können Konfigurationsdateien mit mehreren Sektionen geladen und geschrieben werden.
Beispiel:
Beispiel einer Konfigurationsdatei:
[server]
ip=127.0.0.1
port=8080
path=/var/tmp
[user]
# In dieser Sektion werden Username und Passwort gespeichert
root=fhrquofhqufhqo
patrick=kngbhwloh
[allowedhosts]
# In dieser Sektion befinden sich IP-Adressen oder Hostnamen von den Rechnern,
# denen der Zugriff auf das Programm erlaubt ist.
192.168.0.1
192.168.0.2
192.168.0.3
192.168.0.4

Beschreibung der Konstruktoren und Destruktoren

ppl6::CConfig::CConfig ( )
ppl6::CConfig::CConfig ( const char *  filename)
ppl6::CConfig::CConfig ( CFileObject file)
ppl6::CConfig::~CConfig ( )

Dokumentation der Elementfunktionen

int ppl6::CConfig::Add ( const char *  section,
const char *  key,
const char *  value 
)
int ppl6::CConfig::Add ( const char *  key,
const char *  value 
)
int ppl6::CConfig::Add ( const char *  key,
int  value 
)
int ppl6::CConfig::Add ( const char *  section,
const char *  key,
int  value 
)
int ppl6::CConfig::Add ( const char *  section,
const char *  key,
bool  value 
)
int ppl6::CConfig::CreateSection ( const char *  section)
int ppl6::CConfig::Delete ( const char *  key)
int ppl6::CConfig::Delete ( const char *  section,
const char *  key 
)
int ppl6::CConfig::DeleteSection ( const char *  section)
void * ppl6::CConfig::FindSection ( const char *  sectionname)
private
int ppl6::CConfig::FirstSection ( )
const char * ppl6::CConfig::Get ( const char *  key,
const char *  defaultvalue = NULL 
)
const char * ppl6::CConfig::Get ( const char *  section,
const char *  key,
const char *  defaultvalue = NULL 
)
bool ppl6::CConfig::GetBool ( const char *  section,
const char *  key,
bool  defaultvalue = false 
)
bool ppl6::CConfig::GetBool ( const char *  key,
bool  defaultvalue = false 
)
int ppl6::CConfig::GetFirst ( char **  key,
char **  value 
)
int ppl6::CConfig::GetFirst ( CString key,
CString value 
)
int ppl6::CConfig::GetInt ( const char *  section,
const char *  key,
int  defaultvalue = 0 
)
int ppl6::CConfig::GetInt ( const char *  key,
int  defaultvalue = 0 
)
int ppl6::CConfig::GetNext ( char **  key,
char **  value 
)
int ppl6::CConfig::GetNext ( CString key,
CString value 
)
const char * ppl6::CConfig::GetSection ( const char *  section)
Include:
#include <ppl6.h>
Beschreibung:
Mit dieser Funktion wird der komplette Inhalt einer Sektion als char* zurückgegeben
Parameter
sectionDer Name der Sektion ohne Eckige Klammern
Rückgabe
Im Erfolgsfall liefert die Funktion einen char-Pointer auf den Inhalt der Sektion zurück. Im Fehlerfall wird NULL zurückgegeben und der Fehlercode kann wie üblich mit den Fehlerfunktionen abgefragt werden.
const char * ppl6::CConfig::GetSectionName ( )
void ppl6::CConfig::Init ( )
private
int ppl6::CConfig::IsTrue ( const char *  value)
int ppl6::CConfig::Load ( const char *  filename,
  ... 
)
Include:
#include <ppl6.h>
Beschreibung:
Mit dieser Funktion wird eine Konfiguration aus einer Datei geladen.
Parameter
filenameEin Pointer auf dem Dateinamen oder einen Formatierungsstring
...Optionale Parameter für den Formatstring
Rückgabe
Bei Erfolg gibt die Funktion true (1) zurück, im Fehlerfall false (0). Der genaue Fehlercode kann wie üblich mit den Fehlerfunktionen abgefragt werden.
int ppl6::CConfig::Load ( CFileObject file)
Include:
#include <ppl6.h>
Beschreibung:
Mit dieser Funktion wird eine Konfiguration aus einem CFileObject-Objekt geladen. Die Funktion wird intern von den anderen Load-Funktionen verwendet.
Parameter
fileEin Pointer auf eine CFileObject-Klasse
Rückgabe
Bei Erfolg gibt die Funktion true (1) zurück, im Fehlerfall false (0). Der genaue Fehlercode kann wie üblich mit den Fehlerfunktionen abgefragt werden.
Siehe auch
Load(CString *string)
Load(char *filename, ...)
LoadFromMemory(void *buffer, int bytes)
int ppl6::CConfig::LoadFromMemory ( void *  buffer,
int  bytes 
)
Include:
#include <ppl6.h>
Beschreibung:
Mit dieser Funktion wird eine bereits im Speicher befindliche Konfiguration in das CConfig-Objekt geladen.
Parameter
bufferEin Pointer auf den Beginn des Speicherbereichs
bytesDie Größe des Speicherbereichs
Rückgabe
Bei Erfolg gibt die Funktion true (1) zurück, im Fehlerfall false (0). Der genaue Fehlercode kann wie üblich mit den Fehlerfunktionen abgefragt werden.
Seit
Diese Funktion wurde mit Version 6.0.19 eingeführt
int ppl6::CConfig::LoadFromString ( CString string)
Include:
#include <ppl6.h>
Beschreibung:
Mit dieser Funktion wird eine in einem CString enthaltene Konfiguration in das CConfig-Objekt geladen.
Parameter
stringEin Pointer auf die CString-Klasse
Rückgabe
Bei Erfolg gibt die Funktion true (1) zurück, im Fehlerfall false (0). Der genaue Fehlercode kann wie üblich mit den Fehlerfunktionen abgefragt werden.
Seit
Diese Funktion wurde mit Version 6.0.19 eingeführt
int ppl6::CConfig::NextSection ( )
void ppl6::CConfig::Print ( )
Include:
#include <ppl6.h>
Beschreibung:
Mit dieser Funktion wird die geladene Konfiguration auf STDOUT ausgegeben.
CAssocArray * ppl6::CConfig::ReadSection ( const char *  section,
CAssocArray a = NULL 
)
Include:
#include <ppl6.h>
Beschreibung:
Mit dieser Funktion wird der Inhalt einer Sektion ein ein Assoziatives Array kopiert.
Parameter
sectionDer Name der Sektion ohne Eckige Klammern
aEin Optionaler Pointer auf ein Assoziatives Array, in dem die Sektion gespeichert werden soll.
Rückgabe
Im Erfolgsfall liefert die Funktion einen Pointer auf ein Assoziatives Array zurück. Wurder der Parameter a angegeben, wird das Ergebnis darin gespeichert und der Return-Wert ist identisch mit a. Ist das nicht der Fall, wird mit new ein neues Array angelegt und der Benutzer muss dafür sorgen, dass dieses wieder gelöscht wird. Im Fehlerfall wird NULL zurückgegeben und der Fehlercode kann wie üblich mit den Fehlerfunktionen abgefragt werden.
void ppl6::CConfig::Reset ( )
int ppl6::CConfig::Save ( const char *  filename)
int ppl6::CConfig::Save ( CFileObject file)
int ppl6::CConfig::SelectSection ( const char *  section)
void ppl6::CConfig::SetSeparator ( const char *  string)
int ppl6::CConfig::String2Point ( const char *  string,
POINT p 
)
void ppl6::CConfig::String2Rect ( const char *  string,
RECT r 
)
void ppl6::CConfig::Unload ( )

Dokumentation der Datenelemente

char* ppl6::CConfig::currentsection
private
void* ppl6::CConfig::first
private
bool ppl6::CConfig::isused
private
void * ppl6::CConfig::last
private
void * ppl6::CConfig::section
private
CAssocArray ppl6::CConfig::sections
private
char* ppl6::CConfig::separator
private
size_t ppl6::CConfig::separatorLength
private

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien: