Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

Form Variables Handling


Functions

u_string_t * var_get_name_s (var_t *v)
 Get name u_string_t of a variable.
u_string_t * var_get_value_s (var_t *v)
 Get u_string_t value of a variable.
const char * var_get_name (var_t *v)
 Get the name of a variable.
const char * var_get_value (var_t *v)
 Get the value of a variable.
size_t var_get_value_size (var_t *v)
 Get the size of a variable value.
int var_set (var_t *var, const char *name, const char *value)
 Set the name and value of a variable.
int var_set_name (var_t *v, const char *name)
 Set the name of a variable.
int var_set_value (var_t *v, const char *value)
 Set the value of a variable.
int var_set_bin_value (var_t *v, const char *data, size_t size)
 Set binary value of a variable.
u_string_t * vars_get_value_s (vars_t *vs, const char *name)
 Get u_string_t value of a variable.
var_tvars_getn (vars_t *vs, size_t i)
 Get ith variable.
size_t vars_count (vars_t *vs)
 Count the number of variables.
size_t vars_countn (vars_t *vs, const char *name)
 Count the number of variables with given name.
int vars_add_urlvar (vars_t *vs, const char *cstr, var_t **v)
 Add an URL variable.
var_tvars_geti (vars_t *vs, const char *var_name, size_t i)
 Get i-th variable with given name.
var_tvars_get (vars_t *vs, const char *var_name)
 Get a variable with given name.
int vars_geti_value_i (vars_t *vs, const char *name, size_t ith)
 Get the integer value of a variable with a given name and index.
u_string_t * vars_geti_value_s (vars_t *vs, const char *name, size_t ith)
 Get u_string_t value of i-th variable.
int vars_get_value_i (vars_t *vs, const char *name)
 Get the integer value of a variable with a given name.
const char * vars_geti_value (vars_t *vs, const char *name, size_t ith)
 Get the value of the variable at a given index.
const char * vars_get_value (vars_t *vs, const char *name)
 Get the value of the variable with given name.
void vars_foreach (vars_t *vs, int(*cb)(var_t *, void *), void *arg)
 Execute a function on a list of variables.

Detailed Description


Function Documentation

u_string_t* var_get_name_s var_t v  ) 
 

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.

References var_s::sname.

u_string_t* var_get_value_s var_t v  ) 
 

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.

References var_s::data, var_s::size, and var_s::svalue.

Referenced by vars_get_value_s(), and vars_geti_value_s().

const char* var_get_name var_t v  ) 
 

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 136 of file var.c.

References var_s::sname.

const char* var_get_value var_t v  ) 
 

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 153 of file var.c.

References var_s::data.

Referenced by request_get_arg(), request_get_cookie(), session_get(), and vars_geti_value().

size_t var_get_value_size var_t v  ) 
 

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 170 of file var.c.

References var_s::size.

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

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 189 of file var.c.

References var_set_name(), and var_set_value().

int var_set_name var_t v,
const char *  name
 

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 214 of file var.c.

References var_s::sname.

Referenced by var_set().

int var_set_value var_t v,
const char *  value
 

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 237 of file var.c.

References var_set_bin_value().

Referenced by session_set(), and var_set().

int var_set_bin_value var_t v,
const char *  data,
size_t  size
 

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 258 of file var.c.

References var_s::data, var_s::size, and var_s::svalue.

Referenced by var_set_value().

u_string_t* vars_get_value_s vars_t *  vs,
const char *  name
 

Return an u_string_t containing the value of variable with name in variable list vs.

Parameters:
vs variable list
name name of variable
Returns:
the variable value (may be NULL)

Definition at line 39 of file vars.c.

References var_get_value_s(), and vars_get().

var_t* vars_getn vars_t *  vs,
size_t  i
 

Return the var_t at index i in list vs.

Parameters:
vs variable list
i index
Returns:
the ith variable or NULL if there's no ith var in vs

Definition at line 121 of file vars.c.

Referenced by session_clean().

size_t vars_count vars_t *  vs  ) 
 

Return a the number of variables in a list

Parameters:
vs variable list
Returns:
the number of elements in vs

Definition at line 148 of file vars.c.

Referenced by request_get_uploaded_file().

size_t vars_countn vars_t *  vs,
const char *  name
 

Return a the number of variables in a list with given name name

Parameters:
vs variable list
name name of the variables to count
Returns:
the number of elements in vs whose name is name

Definition at line 166 of file vars.c.

References var_s::sname.

int vars_add_urlvar vars_t *  vs,
const char *  cstr,
var_t **  v
 

Parse the "name=value" string cstr, url-decode name and value and push it into vs. The variable is returned at *v.

Parameters:
vs variables' list where the variable is pushed
cstr URL string to parse
v the generated variable as a value-result argument
Returns:
0 if successful, non-zero on error

Definition at line 195 of file vars.c.

References u_urlncpy().

var_t* vars_geti vars_t *  vs,
const char *  var_name,
size_t  i
 

Return the var_t object at index i with name var_name in list vs.

Parameters:
vs variable list
var_name variable name
i index
Returns:
  • the var_t object found
  • NULL if there's no i-th variable called var_name in vs

Definition at line 311 of file vars.c.

References var_s::sname.

Referenced by request_get_uploaded_file(), vars_get(), vars_geti_value(), and vars_geti_value_s().

var_t* vars_get vars_t *  vs,
const char *  var_name
 

Return a var_t object with name name in list vs.

Parameters:
vs variable list
var_name variable name
Returns:
  • the var_t object found
  • NULL if there's no variable called var_name in vs

Definition at line 344 of file vars.c.

References vars_geti().

Referenced by request_get_arg(), request_get_cookie(), session_del(), session_get(), session_set(), and vars_get_value_s().

int vars_geti_value_i vars_t *  vs,
const char *  name,
size_t  ith
 

Get the integer value of the variable with name name and index ith in list vs.

Parameters:
vs variable list
name variable name
ith index
Returns:
  • the integer value of name
  • 0 if no value could be found

Definition at line 367 of file vars.c.

References vars_geti_value().

Referenced by vars_get_value_i().

u_string_t* vars_geti_value_s vars_t *  vs,
const char *  name,
size_t  ith
 

Return an u_string_t containing the value of i-th variable with name in variable list vs.

Parameters:
vs variable list
name name of variable
ith index
Returns:
the variable value (may be NULL)

Definition at line 394 of file vars.c.

References var_get_value_s(), and vars_geti().

int vars_get_value_i vars_t *  vs,
const char *  name
 

Return the integer value of the variable with name name in list vs.

Parameters:
vs variable list
name variable name
Returns:
  • the integer value of name
  • 0 if no value could be found

Definition at line 421 of file vars.c.

References vars_geti_value_i().

const char* vars_geti_value vars_t *  vs,
const char *  name,
size_t  ith
 

Return the string value of the variable with name name and index ith in list vs.

Parameters:
vs variable list that is scanned
name variable name to search
ith index of the searched variable
Returns:
  • the value string corresponding to name at i-th position
  • NULL if no value could be found

Definition at line 444 of file vars.c.

References var_get_value(), and vars_geti().

Referenced by vars_get_value(), and vars_geti_value_i().

const char* vars_get_value vars_t *  vs,
const char *  name
 

Return the string value of the variable with name name in list vs.

Parameters:
vs variable list that is scanned
name variable name to search
Returns:
  • the value string corresponding to name
  • NULL if no value could be found

Definition at line 469 of file vars.c.

References vars_geti_value().

void vars_foreach vars_t *  vs,
int(*)(var_t *, void *)  cb,
void *  arg
 

Execute function cb with optional arguments arg on all variables in list vs

Parameters:
vs variable list
cb function to be called on each variable (see prototype)
arg argument to cb
Returns:
nothing

Definition at line 490 of file vars.c.