Macro variables
[HTTP Interface]

Collaboration diagram for Macro variables:

These variables can be used in the <vlc> macros and in the RPN evaluator. More...

Data Structures

struct  mvar_s
struct  mvar_t
 This structure defines a macro variable. More...

Typedefs

typedef mvar_s mvar_t

Functions

mvar_tmvar_New (const char *name, const char *value)
 This function creates a new variable.
void mvar_Delete (mvar_t *v)
 This function deletes a variable.
void mvar_AppendVar (mvar_t *v, mvar_t *f)
 This function adds f to the children variables of v, at last position.
mvar_tmvar_Duplicate (const mvar_t *v)
 This function duplicates a variable.
void mvar_PushVar (mvar_t *v, mvar_t *f)
 This function adds f to the children variables of v, at fist position.
void mvar_RemoveVar (mvar_t *v, mvar_t *f)
 This function removes f from the children variables of v.
mvar_tmvar_GetVar (mvar_t *s, const char *name)
 This function retrieves the child variable named "name".
char * mvar_GetValue (mvar_t *v, char *field)
 This function retrieves the value of the child variable named "field".
void mvar_PushNewVar (mvar_t *vars, const char *name, const char *value)
 This function creates a variable with the given name and value and adds it as first child of vars.
void mvar_AppendNewVar (mvar_t *vars, const char *name, const char *value)
 This function creates a variable with the given name and value and adds it as last child of vars.

Detailed Description

These variables can be used in the <vlc> macros and in the RPN evaluator.

The variables make a tree: each variable can have an arbitrary number of "children" variables. A number of helper functions are provided to manipulate the main variable structure


Typedef Documentation

typedef struct mvar_s mvar_t


Function Documentation

void mvar_AppendNewVar ( mvar_t vars,
const char *  name,
const char *  value 
)

This function creates a variable with the given name and value and adds it as last child of vars.

void mvar_AppendVar ( mvar_t v,
mvar_t f 
)

This function adds f to the children variables of v, at last position.

void mvar_Delete ( mvar_t v  ) 

This function deletes a variable.

mvar_t* mvar_Duplicate ( const mvar_t v  ) 

This function duplicates a variable.

char* mvar_GetValue ( mvar_t v,
char *  field 
)

This function retrieves the value of the child variable named "field".

mvar_t* mvar_GetVar ( mvar_t s,
const char *  name 
)

This function retrieves the child variable named "name".

mvar_t* mvar_New ( const char *  name,
const char *  value 
)

This function creates a new variable.

void mvar_PushNewVar ( mvar_t vars,
const char *  name,
const char *  value 
)

This function creates a variable with the given name and value and adds it as first child of vars.

void mvar_PushVar ( mvar_t v,
mvar_t f 
)

This function adds f to the children variables of v, at fist position.

void mvar_RemoveVar ( mvar_t v,
mvar_t f 
)

This function removes f from the children variables of v.


Generated on Wed Aug 13 08:05:55 2008 for VLC by  doxygen 1.5.1