Classes | Public Member Functions

# USpeedGameEngine::IniFile Class Reference

Classe permettant de lire et écrire les fichiers INI. More...

List of all members.

## Classes

struct | IniCouple
| Structure de stockage des informations des couples (clé/valeur). More...
struct | IniSection
| Structure de stockage des informations des couples (clé/valeur) issue d'un fichier INI pour une section. More...

## Public Member Functions

| IniFile ()
| Constructeur par défaut.
| ~IniFile ()
| Destructeur par défaut.
bool | load (const char *filename)
| Charge le fichier INI spécifié.
bool | loadFromBuffer (std::string const &data)
| Charge les données INI spécifiées.
std::string | getValue (const char *section, const char *key, const char *defaultValue)
| Retourne la valeur pour la clé et la section spécifiée.
std::string | getValue (std::string const &section, std::string const &key, std::string const &defaultValue)
| Retourne la valeur pour la clé et la section spécifiée Si la clé/section n'est pas trouvée, on retourne "defaultValue".
void | getValue (const char *key, const char *defaultValue, std::string &target)
| Retourne la valeur pour la clé et la section spécifiée.
void | getValue (const char *section, const char *key, const char *defaultValue, std::string &target)
| Retourne la valeur pour la clé et la section spécifiée.
bool | isEmpty ()
| Permet de savoir si il y a des données ou pas.
void | reset ()
| Initilialise les variables.

## Detailed Description

Classe permettant de lire et écrire les fichiers INI.

Author:
  U.Speed

## Constructor & Destructor Documentation

IniFile::IniFile | ( |  | ) |

Constructeur par défaut.

Author:
  U.Speed

IniFile::~IniFile | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

std::string IniFile::getValue | ( | const char * | section,
|  | const char * | key,
|  | const char * | defaultValue |
| ) |  |  |

Retourne la valeur pour la clé et la section spécifiée.

Si la clé/section n'est pas trouvée, on retourne "defaultValue".

Author:
  U.Speed

See also:
  void IniFile::getValue(const char *section, const char *key, const char *defaultValue, std::string &target)

Parameters:

  | section | const char* : la section à laquelle doit appartenir la clé
  | key | const char* : la clé pour laquelle on veut connaître la valeur
  | defaultValue | const char* : valeur à retourner si on ne trouve pas ce que l'on demande

Returns:
  std::string : la valeur associée à la clé

std::string IniFile::getValue | ( | std::string const & | section,
|  | std::string const & | key,
|  | std::string const & | defaultValue |
| ) |  |  |

Retourne la valeur pour la clé et la section spécifiée
Si la clé/section n'est pas trouvée, on retourne "defaultValue".

Author:
  U.Speed

See also:
  void IniFile::getValue(const char *section, const char *key, const char *defaultValue, std::string &target)

Parameters:

  | section | std::string const& : la section à laquelle doit appartenir la clé
  | key | std::string const& : la clé pour laquelle on veut connaître la valeur
  | defaultValue | std::string const& : valeur à retourner si on ne trouve pas ce que l'on demande

Returns:
  std::string : la valeur associée à la clé

void IniFile::getValue | ( | const char * | key,
|  | const char * | defaultValue,
|  | std::string & | target |
| ) |  |  |

Retourne la valeur pour la clé et la section spécifiée.

Si la clé/section n'est pas trouvée, on retourne "defaultValue".
La valeur est écrite dans la référence "<code>target</code>".
La clé ne doit pas être dans une section.

Author:
  U.Speed

See also:
  void IniFile::getValue(const char *section, const char *key, const char *defaultValue, std::string &target)

Parameters:

  | key | const char* : la clé pour laquelle on veut connaître la valeur
  | defaultValue | const char* : valeur à retourner si on ne trouve pas ce que l'on demande
  | target | std::string& : cible de la valeur trouvée

Returns:
  std::string : la valeur associée à la clé

void IniFile::getValue | ( | const char * | section,
|  | const char * | key,
|  | const char * | defaultValue,
|  | std::string & | target |
| ) |  |  |

Retourne la valeur pour la clé et la section spécifiée.

Si la clé/section n'est pas trouvée, on retourne "defaultValue".
La valeur est écrite dans la référence "<code>target</code>".

Author:
  U.Speed

Parameters:

  | section | const char* : la section à laquelle doit appartenir la clé
  | key | const char* : la clé pour laquelle on veut connaître la valeur
  | defaultValue | const char* : valeur à retourner si on ne trouve pas ce que l'on demande
  | target | std::string& : cible de la valeur trouvée

Returns:
  std::string : la valeur associée à la clé

bool IniFile::isEmpty | ( |  | ) |

Permet de savoir si il y a des données ou pas.

Author:
  U.Speed

Returns:
  bool : `false` si il y a des données

bool IniFile::load | ( | const char * | filename | ) |

Charge le fichier INI spécifié.

Author:
  U.Speed

Parameters:

  | filename | const char* : le fichier à lire

Returns:
  bool : l'état du chargement
  - true : fichier chargé
  - false : échec du chargement

bool IniFile::loadFromBuffer | ( | std::string const & | data | ) |

Charge les données INI spécifiées.

Author:
  U.Speed

Parameters:

  | data | std::string const& : les données à interprêter

Returns:
  bool : l'état du chargement
  - true : données chargées
  - false : échec du chargement

void IniFile::reset | ( |  | ) |

Initilialise les variables.

Author:
  U.Speed

The documentation for this class was generated from the following files:

- src/IniFile/IniFile.hpp
- src/IniFile/IniFile.cpp
- src/IniFile/IniFile_getValue.cpp
- src/IniFile/IniFile_isEmpty.cpp
- src/IniFile/IniFile_load.cpp
- src/IniFile/IniFile_loadFromBuffer.cpp
- src/IniFile/IniFile_loadValue.cpp
- src/IniFile/IniFile_reset.cpp