OpenVAS Libraries  4.0+rc3.SVN
Functions
base/settings.c File Reference

Implementation of API to handle configuration file management. More...

#include <string.h>
#include <stdio.h>
#include <errno.h>
#include <sys/stat.h>
#include "settings.h"

Functions

int settings_init_from_file (settings_t *settings, const gchar *filename, const gchar *group)
 Initialise a settings struct from a file.
int settings_init (settings_t *settings, const gchar *filename, const gchar *group)
 Initialise a settings struct.
void settings_cleanup (settings_t *settings)
 Cleanup a settings structure.
void settings_set (settings_t *settings, const gchar *name, const gchar *value)
 Set a settings name value pair.
int settings_save (settings_t *settings)
 Save settings.
int init_settings_iterator_from_file (settings_iterator_t *iterator, const gchar *filename, const gchar *group)
 Initialise a settings iterator from a file.
int init_settings_iterator (settings_iterator_t *iterator, const gchar *filename, const gchar *group)
 Initialise a settings iterator.
void cleanup_settings_iterator (settings_iterator_t *iterator)
 Cleanup a settings iterator.
gboolean settings_iterator_next (settings_iterator_t *iterator)
 Increment an iterator.
const gchar * settings_iterator_name (settings_iterator_t *iterator)
 Get the name from a settings iterator.
const gchar * settings_iterator_value (settings_iterator_t *iterator)
 Get the value from a settings iterator.

Detailed Description

Implementation of API to handle configuration file management.


Function Documentation

Cleanup a settings iterator.

Parameters:
[in]iteratorSettings iterator.
int init_settings_iterator ( settings_iterator_t iterator,
const gchar *  filename,
const gchar *  group 
)

Initialise a settings iterator.

Parameters:
[in]iteratorSettings iterator.
[in]filenameComplete name of the configuration file.
[in]groupName of the group in the file.
Returns:
0 success, -1 error.
int init_settings_iterator_from_file ( settings_iterator_t iterator,
const gchar *  filename,
const gchar *  group 
)

Initialise a settings iterator from a file.

Parameters:
[in]iteratorSettings iterator.
[in]filenameComplete name of the configuration file.
[in]groupName of the group in the file.
Returns:
0 success, -1 error.
void settings_cleanup ( settings_t settings)

Cleanup a settings structure.

Parameters:
[in]iteratorSettings iterator.
int settings_init ( settings_t settings,
const gchar *  filename,
const gchar *  group 
)

Initialise a settings struct.

Parameters:
[in]settingsSettings.
[in]filenameComplete name of the configuration file.
[in]groupName of the group in the file.
Returns:
0 success, -1 error.
int settings_init_from_file ( settings_t settings,
const gchar *  filename,
const gchar *  group 
)

Initialise a settings struct from a file.

Parameters:
[in]settingsSettings.
[in]filenameComplete name of the configuration file.
[in]groupName of the group in the file.
Returns:
0 success, -1 error.
const gchar* settings_iterator_name ( settings_iterator_t iterator)

Get the name from a settings iterator.

Parameters:
[in]iteratorSettings iterator.
Returns:
Name of current key.
gboolean settings_iterator_next ( settings_iterator_t iterator)

Increment an iterator.

Parameters:
[in]iteratorSettings iterator.
Returns:
TRUE if there was a next item, else FALSE.
const gchar* settings_iterator_value ( settings_iterator_t iterator)

Get the value from a settings iterator.

Parameters:
[in]iteratorSettings iterator.
Returns:
Value of current key.
int settings_save ( settings_t settings)

Save settings.

Parameters:
[in]settingsSettings.
Returns:
0 success, -1 error.
void settings_set ( settings_t settings,
const gchar *  name,
const gchar *  value 
)

Set a settings name value pair.

Parameters:
[in]settingsSettings.
[in]nameName of setting.
[in]valueValue of setting.