VuoList_VuoKey

Description

A list of VuoKey elements.

Typedefs
typedef void *	VuoList_VuoKey
	A list of VuoKey elements.

Functions
VuoList_VuoKey	VuoListCreate_VuoKey (void)
	Creates a new list of VuoKey elements.
VuoKey	VuoListGetValueAtIndex_VuoKey (const VuoList_VuoKey list, const unsigned long index)
	Returns the VuoKey at index.
void	VuoListSetValueAtIndex_VuoKey (const VuoList_VuoKey list, const VuoKey value, const unsigned long index)
	Changes the VuoKey at index.
void	VuoListAppendValue_VuoKey (VuoList_VuoKey list, const VuoKey value)
	Appends value to list.
void	VuoListRemoveFirstValue_VuoKey (VuoList_VuoKey list)
	Removes the first value from list.
void	VuoListRemoveLastValue_VuoKey (VuoList_VuoKey list)
	Removes the last value from list.
void	VuoListRemoveAll_VuoKey (VuoList_VuoKey list)
	Removes all values from list.
unsigned long	VuoListGetCount_VuoKey (const VuoList_VuoKey list)
	Returns the number of elements in list.
VuoList_VuoKey	VuoList_VuoKey_valueFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value.
struct json_object *	VuoList_VuoKey_jsonFromValue (const VuoList_VuoKey value)
	Encodes value as a JSON object.
char *	VuoList_VuoKey_summaryFromValue (const VuoList_VuoKey value)
	Produces a brief human-readable summary of value.
VuoList_VuoKey	VuoList_VuoKey_valueFromString (const char *str)
	Automatically generated function.
char *	VuoList_VuoKey_stringFromValue (const VuoList_VuoKey value)
	Automatically generated function.

Typedef Documentation

typedef void* VuoList_VuoKey

A list of VuoKey elements.

Function Documentation

struct json_object* VuoList_VuoKey_jsonFromValue ( const VuoList_VuoKey  value )

read

Encodes value as a JSON object.

char* VuoList_VuoKey_stringFromValue

(

const VuoList_VuoKey

value

)

Automatically generated function.

char* VuoList_VuoKey_summaryFromValue

(

const VuoList_VuoKey

value

)

Produces a brief human-readable summary of value.

VuoList_VuoKey VuoList_VuoKey_valueFromJson

(

struct json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

["uno", "dos", "tres", "catorce"]

VuoList_VuoKey VuoList_VuoKey_valueFromString

(

const char *

str

)

Automatically generated function.

void VuoListAppendValue_VuoKey	(	VuoList_VuoKey	list,
		const VuoKey	value
	)

Appends value to list.

VuoList_VuoKey VuoListCreate_VuoKey

(

void

)

Creates a new list of VuoKey elements.

unsigned long VuoListGetCount_VuoKey

(

const VuoList_VuoKey

list

)

Returns the number of elements in list.

VuoKey VuoListGetValueAtIndex_VuoKey	(	const VuoList_VuoKey	list,
		const unsigned long	index
	)

Returns the VuoKey at index.

Index values start at 1. If the list has no items, returns a default value. Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).

void VuoListRemoveAll_VuoKey

(

VuoList_VuoKey

list

)

Removes all values from list.

void VuoListRemoveFirstValue_VuoKey

(

VuoList_VuoKey

list

)

Removes the first value from list.

void VuoListRemoveLastValue_VuoKey

(

VuoList_VuoKey

list

)

Removes the last value from list.

void VuoListSetValueAtIndex_VuoKey	(	const VuoList_VuoKey	list,
		const VuoKey	value,
		const unsigned long	index
	)

Changes the VuoKey at index.

Index values start at 1. If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).