From e5e33247ff9abe01a87bd7b8ebd050c549e2814f Mon Sep 17 00:00:00 2001 From: Lars Müller Date: Sun, 27 May 2007 15:58:19 +0000 Subject: r23166: Bring samba.org's iniparser copy in sync with the upstream version 2.17. (This used to be commit 3fa98245d98436a0f042ffca9bf102e9f920bace) --- source3/iniparser/html/iniparser_8h.html | 788 +++++++++++++------------------ 1 file changed, 340 insertions(+), 448 deletions(-) (limited to 'source3/iniparser/html/iniparser_8h.html') diff --git a/source3/iniparser/html/iniparser_8h.html b/source3/iniparser/html/iniparser_8h.html index 3f0534f31e..9a7d5ecbc3 100644 --- a/source3/iniparser/html/iniparser_8h.html +++ b/source3/iniparser/html/iniparser_8h.html @@ -10,97 +10,87 @@ - -
-src
+

iniparser.h File Reference

Parser for ini files. More...

- + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - +

Functions

int iniparser_getnsec (dictionary *d)
int iniparser_getnsec (dictionary *d)
 Get number of sections in a dictionary.
char * iniparser_getsecname (dictionary *d, int n)
 Get number of sections in a dictionary.
char * iniparser_getsecname (dictionary *d, int n)
 Get name for section n in a dictionary.
void iniparser_dump_ini (dictionary *d, FILE *f)
 Get name for section n in a dictionary.
void iniparser_dump_ini (dictionary *d, FILE *f)
 Save a dictionary to a loadable ini file.
void iniparser_dump (dictionary *d, FILE *f)
 Save a dictionary to a loadable ini file.
void iniparser_dump (dictionary *d, FILE *f)
 Dump a dictionary to an opened file pointer.
char * iniparser_getstr (dictionary *d, char *key)
 Dump a dictionary to an opened file pointer.
char * iniparser_getstr (dictionary *d, const char *key)
 Get the string associated to a key, return NULL if not found.
char * iniparser_getstring (dictionary *d, char *key, char *def)
 Get the string associated to a key, return NULL if not found.
char * iniparser_getstring (dictionary *d, const char *key, char *def)
 Get the string associated to a key.
int iniparser_getint (dictionary *d, char *key, int notfound)
 Get the string associated to a key.
int iniparser_getint (dictionary *d, const char *key, int notfound)
 Get the string associated to a key, convert to an int.
double iniparser_getdouble (dictionary *d, char *key, double notfound)
 Get the string associated to a key, convert to an int.
double iniparser_getdouble (dictionary *d, char *key, double notfound)
 Get the string associated to a key, convert to a double.
int iniparser_getboolean (dictionary *d, char *key, int notfound)
 Get the string associated to a key, convert to a double.
int iniparser_getboolean (dictionary *d, const char *key, int notfound)
 Get the string associated to a key, convert to a boolean.
int iniparser_setstr (dictionary *ini, char *entry, char *val)
 Get the string associated to a key, convert to a boolean.
int iniparser_setstr (dictionary *ini, char *entry, char *val)
 Set an entry in a dictionary.
void iniparser_unset (dictionary *ini, char *entry)
 Set an entry in a dictionary.
void iniparser_unset (dictionary *ini, char *entry)
 Delete an entry in a dictionary.
int iniparser_find_entry (dictionary *ini, char *entry)
 Delete an entry in a dictionary.
int iniparser_find_entry (dictionary *ini, char *entry)
 Finds out if a given entry exists in a dictionary.
dictionary * iniparser_load (char *ininame)
 Finds out if a given entry exists in a dictionary.
dictionary * iniparser_load (const char *ininame)
 Parse an ini file and return an allocated dictionary object.
void iniparser_freedict (dictionary *d)
 Parse an ini file and return an allocated dictionary object.
void iniparser_freedict (dictionary *d)
 Free all memory associated to an ini dictionary.
 Free all memory associated to an ini dictionary.

Detailed Description

Parser for ini files.

-

Author:
N. Devillard
-
Date:
Mar 2000
-
Version:
Revision
1.20
+
Author:
N. Devillard
+
Date:
Mar 2000
+
Version:
Revision
1.23

Function Documentation

-

- - - - -
- + +
+
+
- - - - + + + + - - - - + + + + - - - + + +
void iniparser_dump ( dictionary *  d, void iniparser_dump (dictionary *  d,
FILE *  fFILE *  f 
) )
-
- - - -
-   - + +

Dump a dictionary to an opened file pointer. @@ -111,42 +101,34 @@ Dump a dictionary to an opened file pointer.

f Opened file pointer to dump to.

-
Returns:
void
-This function prints out the contents of a dictionary, one element by line, onto the provided file pointer. It is OK to specify stderr or stdout as output files. This function is meant for debugging purposes mostly. - - -

- - - - -
- +
Returns:
void
+This function prints out the contents of a dictionary, one element by line, onto the provided file pointer. It is OK to specify stderr or stdout as output files. This function is meant for debugging purposes mostly. + +

+ +

+
+
- - - - + + + + - - - - + + + + - - - + + +
void iniparser_dump_ini ( dictionary *  d, void iniparser_dump_ini (dictionary *  d,
FILE *  fFILE *  f 
) )
-
- - - -
-   - + +

Save a dictionary to a loadable ini file. @@ -157,42 +139,34 @@ Save a dictionary to a loadable ini file.

f Opened file pointer to dump to
-

Returns:
void
-This function dumps a given dictionary into a loadable ini file. It is Ok to specify stderr or stdout as output files. - - -

- - - - -
- +
Returns:
void
+This function dumps a given dictionary into a loadable ini file. It is Ok to specify stderr or stdout as output files. + +

+ +

+
+
- - - - + + + + - - - - + + + + - - - + + +
int iniparser_find_entry ( dictionary *  ini, int iniparser_find_entry (dictionary *  ini,
char *  entrychar *  entry 
) )
-
- - - -
-   - + +

Finds out if a given entry exists in a dictionary. @@ -203,33 +177,25 @@ Finds out if a given entry exists in a dictionary.

entry Name of the entry to look for
-

Returns:
integer 1 if entry exists, 0 otherwise
-Finds out if a given entry exists in the dictionary. Since sections are stored as keys with NULL associated values, this is the only way of querying for the presence of sections in a dictionary. - - -

- - - - -
- - - - - - - - +
Returns:
integer 1 if entry exists, 0 otherwise
+Finds out if a given entry exists in the dictionary. Since sections are stored as keys with NULL associated values, this is the only way of querying for the presence of sections in a dictionary. + +

+ +

+
+
void iniparser_freedict ( dictionary *  d  ) 
+ + + + + + +
void iniparser_freedict (dictionary *  d  ) 
-
- - - -
-   - + +

Free all memory associated to an ini dictionary. @@ -239,48 +205,40 @@ Free all memory associated to an ini dictionary.

d Dictionary to free
-

Returns:
void
-Free all memory associated to an ini dictionary. It is mandatory to call this function before the dictionary object gets out of the current context. - - -

- - - - -
- +
Returns:
void
+Free all memory associated to an ini dictionary. It is mandatory to call this function before the dictionary object gets out of the current context. + +

+ +

+
+
- - - - + + + + - - - - + + + + - - - - + + + + - - - + + +
int iniparser_getboolean ( dictionary *  d, int iniparser_getboolean (dictionary *  d,
char *  key, const char *  key,
int  notfoundint  notfound 
) )
-
- - - -
-   - + +

Get the string associated to a key, convert to a boolean. @@ -292,7 +250,7 @@ Get the string associated to a key, convert to a boolean.

notfound Value to return in case of error
-

Returns:
integer
+
Returns:
integer
This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.

A true boolean is found if one of the following is matched: