mrparam_t Struct Reference

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

#include <mrparam.h>

Public Member Functions
void	mrparam_empty (mrparam_t *param)
	Delete all parameters in the object. 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, eg.

• MRP_FILE - the file associated with a message, not for text messages
• MRP_WIDTH - the width of an image or video
• MRP_HEIGHT - the height of an image or video
• MRP_DURATION - the duration of an video or audio

However, for most functions, it is easier to use more conctrete functions as mrmsg_get_file().

Member Function Documentation

void mrparam_empty

(

mrparam_t *

param

)

Delete all parameters in the object.

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.

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. NULL to clear the value.

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.

---

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