Delta Chat Core C-API
Public Member Functions | List of all members
mrparam_t Struct Reference

An object for handling key=value parameter lists. More...

#include <mrparam.h>

Public Member Functions

mrparam_tmrparam_new ()
 Create new parameter list object. More...
 
void mrparam_unref (mrparam_t *param)
 Free an parameter list object created eg. More...
 
void mrparam_empty (mrparam_t *param)
 Delete all parameters. More...
 
int mrparam_exists (mrparam_t *param, int key)
 Check if a parameter exists. More...
 
char * mrparam_get (mrparam_t *param, int key, const char *def)
 Get value of a parameter. More...
 
int32_t mrparam_get_int (mrparam_t *param, int key, int32_t def)
 Get value of a parameter. More...
 
void mrparam_set (mrparam_t *param, int key, const char *value)
 Set parameter to a string. More...
 
void mrparam_set_int (mrparam_t *param, int key, int32_t value)
 Set parameter to an integer. More...
 

Detailed Description

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.

Member Function Documentation

void mrparam_empty ( mrparam_t param)

Delete all parameters.

Parameters
paramParameter object to modify.
Returns
None.
int mrparam_exists ( mrparam_t param,
int  key 
)

Check if a parameter exists.

Parameters
paramParameter object to query.
keyKey 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
paramParameter object to query.
keyKey of the parameter to get, one of the MRP_* constants.
defValue 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
paramParameter object to query.
keyKey of the parameter to get, one of the MRP_* constants.
defValue to return if the parameter is not set.
Returns
The stored value or the default value.
mrparam_t * mrparam_new ( )

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
paramParameter object to modify.
keyKey of the parameter to modify, one of the MRP_* constants.
valueValue to store for key.
Returns
None.
void mrparam_set_int ( mrparam_t param,
int  key,
int32_t  value 
)

Set parameter to an integer.

Parameters
paramParameter object to modify.
keyKey of the parameter to modify, one of the MRP_* constants.
valueValue to store for key.
Returns
None.
void mrparam_unref ( mrparam_t param)

Free an parameter list object created eg.

by mrparam_new().

Parameters
paramThe parameter list object to free.

The documentation for this struct was generated from the following files: