variable_t Struct Reference

The structure describing a variable. More...

Collaboration diagram for variable_t:

[legend]

Data Fields
vlc_value_t	val
	The variable's exported value.
char *	psz_name
	The variable unique name.
uint32_t	i_hash
	(almost) unique hashed value
int	i_type
	The type of the variable.
char *	psz_text
	The variable display name, mainly for use by the interfaces.
int(*	pf_cmp )(vlc_value_t, vlc_value_t)
	A pointer to a comparison function.
void(*	pf_dup )(vlc_value_t *)
	A pointer to a duplication function.
void(*	pf_free )(vlc_value_t *)
	A pointer to a deallocation function.
int	i_usage
	Creation count: we only destroy the variable if it reaches 0.
vlc_value_t	min
	If the variable has min/max/step values.
vlc_value_t	max
vlc_value_t	step
int	i_default
	Index of the default choice, if the variable is to be chosen in a list.
vlc_list_t	choices
	List of choices.
vlc_list_t	choices_text
	List of friendly names for the choices.
bool	b_incallback
	Set to TRUE if the variable is in a callback.
int	i_entries
	Number of registered callbacks.
callback_entry_t *	p_entries
	Array of registered callbacks.

---

Detailed Description

The structure describing a variable.

Note:

vlc_value_t is the common union for variable values

---

Field Documentation

vlc_value_t variable_t::val

The variable's exported value.

char* variable_t::psz_name

The variable unique name.

uint32_t variable_t::i_hash

(almost) unique hashed value

int variable_t::i_type

The type of the variable.

char* variable_t::psz_text

The variable display name, mainly for use by the interfaces.

int( * variable_t::pf_cmp)(vlc_value_t, vlc_value_t)

A pointer to a comparison function.

void( * variable_t::pf_dup)(vlc_value_t *)

A pointer to a duplication function.

void( * variable_t::pf_free)(vlc_value_t *)

A pointer to a deallocation function.

int variable_t::i_usage

Creation count: we only destroy the variable if it reaches 0.

vlc_value_t variable_t::min

If the variable has min/max/step values.

vlc_value_t variable_t::max

vlc_value_t variable_t::step

int variable_t::i_default

Index of the default choice, if the variable is to be chosen in a list.

vlc_list_t variable_t::choices

List of choices.

vlc_list_t variable_t::choices_text

List of friendly names for the choices.

bool variable_t::b_incallback

Set to TRUE if the variable is in a callback.

int variable_t::i_entries

Number of registered callbacks.

callback_entry_t* variable_t::p_entries

Array of registered callbacks.

---

The documentation for this struct was generated from the following file:

• src/misc/variables.h

---