This documentation describes the Prokee module interface.
Templates
Show templates with parameter T set to: (
T),
(
char),
(
char16_t),
(
char32_t),
(
wchar_t
)
Static Template Methods:
add
bool nvlist::add(char **names,char **values,const char *item_name)
add_if_missing
bool nvlist::add_if_missing(char **names,char **values,const char *item_name)
remove
bool nvlist::remove(char **names,char **values,const char *item_name)
get
char *nvlist::get(char **names,char **values,const char *item_name)
set
bool nvlist::set(char **names,char **values,const char *item_name,const char *item_value)
create
bool nvlist::create(char ***names,char ***values,int ln)
free
void nvlist::free(char **names,char **values)
print_all
void nvlist::print_all(char **names,char **values)
Motivation
Static Template Methods
add
Adds a new item to the names/values lists. The initial value is set to the empty string.
The new item is appended at the end of the list.
The function performs no range checks! There must be at least one free place left in the list.
Signature:
bool nvlist::add(char **names,char **values,const char *item_name)
Parameters:
| char ** | names | [IN] | names |
| char ** | values | [IN] | values |
| const char * | item_name | [IN] | item_name |
Return value:Returns
true.
add_if_missing
Signature:
bool nvlist::add_if_missing(char **names,char **values,const char *item_name)
Parameters:
| char ** | names | [IN] | names |
| char ** | values | [IN] | values |
| const char * | item_name | [IN] | item_name |
remove
Removes an item from the names/values lists.
Signature:
bool nvlist::remove(char **names,char **values,const char *item_name)
Parameters:
| char ** | names | [IN] | names |
| char ** | values | [IN] | values |
| const char * | item_name | [IN] | item_name |
Return value:Returns
true if the item could be removed, or
false, if the item could not be found.
get
Returns the value of the given name. If the name is not found, the function returns
NULL.
Signature:
char *nvlist::get(char **names,char **values,const char *item_name)
Parameters:
| char ** | names | [IN] | names |
| char ** | values | [IN] | values |
| const char * | item_name | [IN] | item_name |
Return value:A null-terminated string or
NULL.
set
Sets the value of an existing item.
Signature:
bool nvlist::set(char **names,char **values,const char *item_name,const char *item_value)
Parameters:
| char ** | names | [IN] | names |
| char ** | values | [IN] | values |
| const char * | item_name | [IN] | item_name |
| const char * | item_value | [IN] | item_value |
Return value:The function returns
false, if the item could not be found. If an item with name
item_name exists, its value will be replaced by the given value and the function returns
true.
create
Creates new name/value lists.
Signature:
bool nvlist::create(char ***names,char ***values,int ln)
Parameters:
| char *** | names | [IN] | names |
| char *** | values | [IN] | values |
| int | ln | | ln |
free
Frees memory allocated for name/value pairs.
Signature:
void nvlist::free(char **names,char **values)
Parameters:
| char ** | names | [IN] | names |
| char ** | values | [IN] | values |
print_all
Prints all name/value pairs to stdout.
Signature:
void nvlist::print_all(char **names,char **values)
Parameters:
| char ** | names | [IN] | names |
| char ** | values | [IN] | values |
This documenta- tion describes the current state of development.
A
aprint