Diffusion C API  6.3.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
diffusion-string.h File Reference

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. More...
 
bool write_diffusion_string_value (const char *value, const BUF_T *buf)
 Write a string value into a BUF_T for an update. More...
 

Function Documentation

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
valuevalue to read from.
stringpointer to a pointer where the string data will be stored
errorpopulated 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.
bool write_diffusion_string_value ( const char *  value,
const BUF_T buf 
)

Write a string value into a BUF_T for an update.

Parameters
valuestring to be written into the BUF_T
bufBUF_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.