var.h File Reference

Go to the source code of this file.

Typedefs

typedef struct var_s var_t

Functions

int var_create (const char *name, const char *value, var_t **)
int var_bin_create (const char *name, const unsigned char *data, size_t size, var_t **)
int var_free (var_t *)
const char * var_get_name (var_t *v)
const char * var_get_value (var_t *v)
size_t var_get_value_size (var_t *v)
u_string_t * var_get_name_s (var_t *v)
u_string_t * var_get_value_s (var_t *v)
int var_set (var_t *, const char *name, const char *value)
int var_set_name (var_t *v, const char *name)
int var_set_value (var_t *v, const char *value)
int var_set_bin_value (var_t *v, const unsigned char *data, size_t size)
void var_set_opaque (var_t *v, void *blob)
void * var_get_opaque (var_t *v)

Typedef Documentation

typedef struct var_s var_t

Definition at line 22 of file var.h.


Function Documentation

int var_bin_create ( const char *  name,
const unsigned char *  data,
size_t  size,
var_t **   
)

Definition at line 68 of file var.c.

int var_create ( const char *  name,
const char *  value,
var_t **   
)

Definition at line 93 of file var.c.

int var_free ( var_t  ) 

Definition at line 108 of file var.c.

const char* var_get_name ( var_t v  ) 

Get the name of a variable.

Return a char* containing the name of variable v.

Parameters:
v variable object
Returns:
the name string of the given v (may be NULL)

Definition at line 138 of file var.c.

u_string_t* var_get_name_s ( var_t v  ) 

Get name u_string_t of a variable.

Return an u_string_t containing the name string of variable v.

Parameters:
v variable object
Returns:
the name string of v (may be NULL)

Definition at line 29 of file var.c.

void* var_get_opaque ( var_t v  ) 

Definition at line 63 of file var.c.

const char* var_get_value ( var_t v  ) 

Get the value of a variable.

Return a char* containing the value of variable v.

Parameters:
v variable object
Returns:
the value string of the given v (may be NULL)

Definition at line 155 of file var.c.

u_string_t* var_get_value_s ( var_t v  ) 

Get u_string_t value of a variable.

Return an u_string_t containing the name string of variable v.

Parameters:
v variable object
Returns:
the value string of v (may be NULL)

Definition at line 46 of file var.c.

size_t var_get_value_size ( var_t v  ) 

Get the size of a variable value.

Return a size_t with the value size of variable v.

Parameters:
v variable object
Returns:
the size of the variable value

Definition at line 172 of file var.c.

int var_set ( var_t var,
const char *  name,
const char *  value 
)

Set the name and value of a variable.

Set variable var to name and value.

Parameters:
var variable object
name string name (null-terminated)
value string value (null-terminated)
Returns:
0 if successful, non-zero on error

Definition at line 191 of file var.c.

int var_set_bin_value ( var_t v,
const unsigned char *  data,
size_t  size 
)

Set binary value of a variable.

Set binary value of variable v.

Parameters:
v variable object
data value data
size value size
Returns:
0 if successful, non-zero on error

Definition at line 261 of file var.c.

int var_set_name ( var_t v,
const char *  name 
)

Set the name of a variable.

Set the name of variable v

Parameters:
v variable object
name variable name (null-terminated)
Returns:
0 if successful, non-zero on error

Definition at line 216 of file var.c.

void var_set_opaque ( var_t v,
void *  blob 
)

Definition at line 58 of file var.c.

int var_set_value ( var_t v,
const char *  value 
)

Set the value of a variable.

Set the value of variable v to value

Parameters:
v variable object
value variable value (null-terminated)
Returns:
0 if successful, non-zero on error

Definition at line 239 of file var.c.