ini_reader.h File Reference

Ini file reader module. More...

#include <kern/kfile.h>

Go to the source code of this file.

Functions

int ini_getString (KFile *fd, const char *section, const char *key, const char *default_value, char *buf, size_t size)
 Returns the value for the given string in char* format.

Detailed Description

Ini file reader module.

The format accepted is:

  • Sections must begin at beginning of line. [ Long name ] will be found only if " Long name " is specified as section name.
  • key can contain any spaces at the beginning and before '=' but not in the middle. Eg. "long key name" is not valid.
  • values will be stripped of spaces at the beginning and will run until end-of-line. Eg. "= long value" will be treated as "long value".
  • no nested sections are allowed.
  • no comments are allowed inside a line with key=value pair.
  • every line that doesn't contain a '=' or doesn't start with '[' will be ignored.
Author:
Luca Ottaviano <lottaviano@develer.com>

Definition in file ini_reader.h.


Function Documentation

int ini_getString ( KFile fd,
const char *  section,
const char *  key,
const char *  default_value,
char *  buf,
size_t  size 
)

Returns the value for the given string in char* format.

Reads the whole input file looking for section and key and fills the provided buffer with the corresponding value. On errors, the function fills the provided buffer with the default value and returns EOF.

Parameters:
fd An initialized KFile structure.
section The section to be looked for.
key The key to search for.
default_value The default value.
buf The buffer to be filled.
size The size of the provided buffer.
Returns:
0 if section and key were found, EOF on errors.

Definition at line 141 of file ini_reader.c.