An object for handling key=value parameter lists.
More...
#include <mrparam.h>
An object for handling key=value parameter lists.
The parameter object is used eg. by mrchat_t or mrmsg_t. To access the single parameters use the setter and getter functions with an MRP_* constant.
Delete all parameters.
- Parameters
-
param | Parameter object to modify. |
- Returns
- None.
int mrparam_exists |
( |
mrparam_t * |
param, |
|
|
int |
key |
|
) |
| |
Check if a parameter exists.
- Parameters
-
param | Parameter object to query. |
key | Key of the parameter to check the existance, one of the MRP_* constants. |
- Returns
- 1=parameter exists in object, 0=parameter does not exist in parameter object.
char * mrparam_get |
( |
mrparam_t * |
param, |
|
|
int |
key, |
|
|
const char * |
def |
|
) |
| |
Get value of a parameter.
- Parameters
-
param | Parameter object to query. |
key | Key of the parameter to get, one of the MRP_* constants. |
def | Value to return if the parameter is not set. |
- Returns
- The stored value or the default value. In both cases, the returned value must be free()'d.
int32_t mrparam_get_int |
( |
mrparam_t * |
param, |
|
|
int |
key, |
|
|
int32_t |
def |
|
) |
| |
Get value of a parameter.
- Parameters
-
param | Parameter object to query. |
key | Key of the parameter to get, one of the MRP_* constants. |
def | Value to return if the parameter is not set. |
- Returns
- The stored value or the default value.
Create new parameter list object.
- Returns
- The created parameter list object.
void mrparam_set |
( |
mrparam_t * |
param, |
|
|
int |
key, |
|
|
const char * |
value |
|
) |
| |
Set parameter to a string.
- Parameters
-
param | Parameter object to modify. |
key | Key of the parameter to modify, one of the MRP_* constants. |
value | Value to store for key. |
- Returns
- None.
void mrparam_set_int |
( |
mrparam_t * |
param, |
|
|
int |
key, |
|
|
int32_t |
value |
|
) |
| |
Set parameter to an integer.
- Parameters
-
param | Parameter object to modify. |
key | Key of the parameter to modify, one of the MRP_* constants. |
value | Value to store for key. |
- Returns
- None.
Free an parameter list object created eg.
by mrparam_new().
- Parameters
-
param | The parameter list object to free. |
The documentation for this struct was generated from the following files:
- /home/bpetersen/projects/deltachat-core/src/mrparam.h
- /home/bpetersen/projects/deltachat-core/src/mrparam.c