Greenbone Vulnerability Management Libraries 22.10.0
prefs.h File Reference

Protos and data structures for NVT Information data sets. More...

#include <glib.h>

Go to the source code of this file.

Functions

void prefs_config (const char *)
 Apply the configs from given file as preferences.
 
const gchar * prefs_get (const gchar *key)
 Get a string preference value via a key.
 
int prefs_get_bool (const gchar *key)
 Get a boolean expression of a preference value via a key.
 
void prefs_set (const gchar *, const gchar *)
 Set a string preference value via a key.
 
void prefs_dump (void)
 Dump the preferences to stdout.
 
int prefs_nvt_timeout (const char *)
 
GHashTable * preferences_get (void)
 Get the pointer to the global preferences structure. Eventually this function should not be used anywhere.
 

Detailed Description

Protos and data structures for NVT Information data sets.

This file contains the protos for prefs.c

Function Documentation

◆ preferences_get()

GHashTable * preferences_get ( void )

Get the pointer to the global preferences structure. Eventually this function should not be used anywhere.

Returns
Pointer to the global preferences structure.

◆ prefs_config()

void prefs_config ( const char * config)

Apply the configs from given file as preferences.

Parameters
configFilename of the configuration file.

◆ prefs_dump()

void prefs_dump ( void )

Dump the preferences to stdout.

◆ prefs_get()

const gchar * prefs_get ( const gchar * key)

Get a string preference value via a key.

Parameters
keyThe identifier for the preference.
Returns
A pointer to a string with the value for the preference. NULL in case for the key no preference was found or the preference is not of type string.

◆ prefs_get_bool()

int prefs_get_bool ( const gchar * key)

Get a boolean expression of a preference value via a key.

Parameters
keyThe identifier for the preference.
Returns
1 if the value is considered to represent "true" and 0 if the value is considered to represent "false". If the preference is of type string, value "yes" is true, anything else is false. Any other type or non-existing key is false.

◆ prefs_nvt_timeout()

int prefs_nvt_timeout ( const char * )

◆ prefs_set()

void prefs_set ( const gchar * key,
const gchar * value )

Set a string preference value via a key.

Parameters
keyThe identifier for the preference. A copy of this will be created if necessary.
valueThe value to set. A copy of this will be created.