LAR Library: iniElement_t Struct Reference

LAR Library

iniElement_t Struct Reference

Descriptor of elements allowed in an INI file. More...

#include <ini.h>

Data Fields

char * group
 Is this entry allowed inside which group? More...
 
char * key
 Name of element. More...
 
int(* handler )(iniElement_t *ini, const char *group, const char *key, const char *value)
 Function that must be called to handle this element. More...
 
void * param
 An optional user-defined parameter that is not touched by the iniParse() function.
 

Detailed Description

Descriptor of elements allowed in an INI file.

Every element present in the INI file but not found here is ignored.

Field Documentation

char* iniElement_t::group

Is this entry allowed inside which group?

Entries with the same key, but different group are allowed and will be selected according to the group. If NULL this entry is allowed inside any group.

int(* iniElement_t::handler) (iniElement_t *ini, const char *group, const char *key, const char *value)

Function that must be called to handle this element.

If it returns any value different than zero, processing will terminate.

Parameters
iniPointer to which element in the iniElements_t table was matched.
groupWhich group we are inside (NULL if none).
keyKey that is being set (value on the left of =).
valueValue to be set to, will be NULL if the line had no =
Returns
Zero on success, any other value interrupts INI file parsing.
char* iniElement_t::key

Name of element.

If NULL any key that does not match any previous definition will match.


The documentation for this struct was generated from the following file:
Generated on Mon Mar 27 2017 15:42:53 for LAR Library by   doxygen 1.8.9.1