diffusion-binary.h File Reference

Binary datatype associated functions. More...

Functions
bool	read_diffusion_binary_value (const DIFFUSION_VALUE_T *value, void **binary, DIFFUSION_API_ERROR *error)
	Get the binary value.
bool	write_diffusion_binary_value (const void *binary, const BUF_T *buf, size_t len)
	Write binary data into a BUF_T for an update.

Detailed Description

Binary datatype associated functions.

Function Documentation

read_diffusion_binary_value()

bool read_diffusion_binary_value	(	const DIFFUSION_VALUE_T *	value,
		void **	binary,
		DIFFUSION_API_ERROR *	error
	)

Get the binary value.

Parameters

value	value to retrieve the binary data from.
binary	pointer to a pointer where the binary data will be stored. Must be freed after use.
error	populated if an error occurs. Can be NULL.

Returns

true if the value is successfully read and binary pointer value set to the binary data. False otherwise.

write_diffusion_binary_value()

bool write_diffusion_binary_value	(	const void *	binary,
		const BUF_T *	buf,
		size_t	len
	)

Write binary data into a BUF_T for an update.

Parameters

binary	value to be written into the BUF_T
buf	BUF_T to write the binary value into
len	the length of the binary value to be written into the BUF_T

Returns

True if the value was successfully written into the BUF_T. False will be returned if buf is NULL.