diffusion-value.h File Reference

Generic datatype value associated functions. More...

Typedefs
typedef struct DIFFUSION_VALUE_T	DIFFUSION_VALUE_T
	Opaque diffusion value data type.

Functions
bool	diffusion_value_get_raw_bytes (const DIFFUSION_VALUE_T *value, void **raw_bytes, size_t *len)
	Retrieve the value's raw bytes.
DIFFUSION_VALUE_T *	diffusion_value_dup (const DIFFUSION_VALUE_T *value)
	Create a copy of a DIFFUSION_VALUE_T.
void	diffusion_value_free (DIFFUSION_VALUE_T *value)
	Free a diffusion value.

Detailed Description

Generic datatype value associated functions.

Function Documentation

diffusion_value_dup()

DIFFUSION_VALUE_T * diffusion_value_dup

(

const DIFFUSION_VALUE_T *

value

)

Create a copy of a DIFFUSION_VALUE_T.

diffusion_value_free should be called on this pointer when no longer needed.

Parameters

value

value to be copied.

Returns

copy of the provided DIFFUSION_VALUE_T. NULL if the value cannot be copied.

diffusion_value_free()

void diffusion_value_free

(

DIFFUSION_VALUE_T *

value

)

Free a diffusion value.

Parameters

value

value to be freed.

diffusion_value_get_raw_bytes()

bool diffusion_value_get_raw_bytes	(	const DIFFUSION_VALUE_T *	value,
		void **	raw_bytes,
		size_t *	len
	)

Retrieve the value's raw bytes.

If the raw bytes are successfully retrieved from the diffusion value, the "len" parameter will have its value set to the length of the returned bytes.

Parameters

value	the diffusion value
raw_bytes	pointer to a pointer to be set
len	size_t pointer to have its value set to the length of the bytes data.

Returns

true if the value's raw bytes were successfully retrieved. False otherwise.