diffusion-string.h File Reference

String datatype associated functions. More...

Functions
bool	read_diffusion_string_value (const DIFFUSION_VALUE_T *value, char **string, DIFFUSION_API_ERROR *error)
	Get the string data from a String diffusion value.
bool	write_diffusion_string_value (const char *value, const BUF_T *buf)
	Write a string value into a BUF_T for an update.

Detailed Description

String datatype associated functions.

Function Documentation

read_diffusion_string_value()

bool read_diffusion_string_value	(	const DIFFUSION_VALUE_T *	value,
		char **	string,
		DIFFUSION_API_ERROR *	error )

Get the string data from a String diffusion value.

Parameters

value	value to read from.
string	pointer to a pointer where the string data will be stored
error	populated if an error occurs. Can be NULL.

Returns

true if the value is successfully read and the string pointer value is set to a pointer containing the string data. False otherwise.

write_diffusion_string_value()

bool write_diffusion_string_value	(	const char *	value,
		const BUF_T *	buf )

Write a string value into a BUF_T for an update.

Parameters

value	string to be written into the BUF_T
buf	BUF_T to write the string value into

Returns

true if the value was successfully written into the BUF_T. False will be returned if the provided string value or buf is NULL.