Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module list from libxml2

Main Menu
Related links

Table of Contents

Function type: xmlListWalker
int	xmlListWalker	(const void * data, 
const void * user)

Callback function used when walking a list with xmlListWalk().

data:the data found in the list
user:extra user provided data to the walker
Returns:0 to stop walking the list, 1 otherwise.

Typedef xmlLink * xmlLinkPtr

void	xmlListReverseWalk	(xmlListPtr l, 
xmlListWalker walker,
const void * user)
void *	xmlLinkGetData	(xmlLinkPtr lk)
int	xmlListInsert	(xmlListPtr l, 
void * data)
int	xmlListEmpty	(xmlListPtr l)
int	xmlListRemoveFirst	(xmlListPtr l, 
void * data)
xmlLinkPtr	xmlListFront	(xmlListPtr l)
void	xmlListSort	(xmlListPtr l)
void	xmlListClear	(xmlListPtr l)
Function type: xmlListDeallocator
void	xmlListDeallocator	(xmlLinkPtr lk)

Callback function used to free data from a list.

lk:the data to deallocate

Structure xmlList
struct _xmlList { The content of this structure is not made public by the API. }

Structure xmlLink
struct _xmlLink { The content of this structure is not made public by the API. }

xmlListPtr	xmlListCreate	(xmlListDeallocator deallocator, 
xmlListDataCompare compare)
int	xmlListAppend	(xmlListPtr l, 
void * data)
int	xmlListRemoveAll	(xmlListPtr l, 
void * data)
xmlListPtr	xmlListDup	(const xmlListPtr old)
Typedef xmlList * xmlListPtr

int	xmlListRemoveLast	(xmlListPtr l, 
void * data)
void	xmlListWalk	(xmlListPtr l, 
xmlListWalker walker,
const void * user)
void	xmlListReverse	(xmlListPtr l)
Function type: xmlListDataCompare
int	xmlListDataCompare	(const void * data0, 
const void * data1)

Callback function used to compare 2 data.

data0:the first data
data1:the second data
Returns:0 is equality, -1 or 1 otherwise depending on the ordering.

int	xmlListSize	(xmlListPtr l)
int	xmlListPushFront	(xmlListPtr l, 
void * data)
xmlLinkPtr	xmlListEnd	(xmlListPtr l)
int	xmlListCopy	(xmlListPtr cur, 
const xmlListPtr old)
void	xmlListPopBack	(xmlListPtr l)
int	xmlListPushBack	(xmlListPtr l, 
void * data)
void	xmlListPopFront	(xmlListPtr l)
void	xmlListDelete	(xmlListPtr l)
void *	xmlListReverseSearch	(xmlListPtr l, 
void * data)
void *	xmlListSearch	(xmlListPtr l, 
void * data)
void	xmlListMerge	(xmlListPtr l1, 
xmlListPtr l2)

Description

Callback function used when walking a list with xmlListWalk().

Function: xmlListReverseWalk

void	xmlListReverseWalk	(xmlListPtr l, 
xmlListWalker walker,
const void * user)

Walk all the element of the list in reverse order and apply the walker function to it

l:a list
walker:a processing function
user:a user parameter passed to the walker function

Function: xmlLinkGetData

void *	xmlLinkGetData	(xmlLinkPtr lk)

See Returns.

lk:a link
Returns:a pointer to the data referenced from this link

Function: xmlListInsert

int	xmlListInsert	(xmlListPtr l, 
void * data)

Insert data in the ordered list at the beginning for this value

l:a list
data:the data
Returns:0 in case of success, 1 in case of failure

Function: xmlListEmpty

int	xmlListEmpty	(xmlListPtr l)

Is the list empty ?

l:a list
Returns:1 if the list is empty, 0 otherwise

Function: xmlListRemoveFirst

int	xmlListRemoveFirst	(xmlListPtr l, 
void * data)

Remove the first instance associated to data in the list

l:a list
data:list data
Returns:1 if a deallocation occured, or 0 if not found

Function: xmlListFront

xmlLinkPtr	xmlListFront	(xmlListPtr l)

Get the first element in the list

l:a list
Returns:the first element in the list, or NULL

Function: xmlListSort

void	xmlListSort	(xmlListPtr l)

Sort all the elements in the list

l:a list

Function: xmlListClear

void	xmlListClear	(xmlListPtr l)

Remove the all data in the list

l:a list
Callback function used to free data from a list.

Function: xmlListCreate

xmlListPtr	xmlListCreate	(xmlListDeallocator deallocator, 
xmlListDataCompare compare)

Create a new list

deallocator:an optional deallocator function
compare:an optional comparison function
Returns:the new list or NULL in case of error

Function: xmlListAppend

int	xmlListAppend	(xmlListPtr l, 
void * data)

Insert data in the ordered list at the end for this value

l:a list
data:the data
Returns:0 in case of success, 1 in case of failure

Function: xmlListRemoveAll

int	xmlListRemoveAll	(xmlListPtr l, 
void * data)

Remove the all instance associated to data in the list

l:a list
data:list data
Returns:the number of deallocation, or 0 if not found

Function: xmlListDup

xmlListPtr	xmlListDup	(const xmlListPtr old)

Duplicate the list

old:the list
Returns:a new copy of the list or NULL in case of error

Function: xmlListRemoveLast

int	xmlListRemoveLast	(xmlListPtr l, 
void * data)

Remove the last instance associated to data in the list

l:a list
data:list data
Returns:1 if a deallocation occured, or 0 if not found

Function: xmlListWalk

void	xmlListWalk	(xmlListPtr l, 
xmlListWalker walker,
const void * user)

Walk all the element of the first from first to last and apply the walker function to it

l:a list
walker:a processing function
user:a user parameter passed to the walker function

Function: xmlListReverse

void	xmlListReverse	(xmlListPtr l)

Reverse the order of the elements in the list

l:a list
Callback function used to compare 2 data.

Function: xmlListSize

int	xmlListSize	(xmlListPtr l)

Get the number of elements in the list

l:a list
Returns:the number of elements in the list

Function: xmlListPushFront

int	xmlListPushFront	(xmlListPtr l, 
void * data)

add the new data at the beginning of the list

l:a list
data:new data
Returns:1 if successful, 0 otherwise

Function: xmlListEnd

xmlLinkPtr	xmlListEnd	(xmlListPtr l)

Get the last element in the list

l:a list
Returns:the last element in the list, or NULL

Function: xmlListCopy

int	xmlListCopy	(xmlListPtr cur, 
const xmlListPtr old)

Move all the element from the old list in the new list

cur:the new list
old:the old list
Returns:0 in case of success 1 in case of error

Function: xmlListPopBack

void	xmlListPopBack	(xmlListPtr l)

Removes the last element in the list

l:a list

Function: xmlListPushBack

int	xmlListPushBack	(xmlListPtr l, 
void * data)

add the new data at the end of the list

l:a list
data:new data
Returns:1 if successful, 0 otherwise

Function: xmlListPopFront

void	xmlListPopFront	(xmlListPtr l)

Removes the first element in the list

l:a list

Function: xmlListDelete

void	xmlListDelete	(xmlListPtr l)

Deletes the list and its associated data

l:a list

Function: xmlListReverseSearch

void *	xmlListReverseSearch	(xmlListPtr l, 
void * data)

Search the list in reverse order for an existing value of @data

l:a list
data:a search value
Returns:the value associated to @data or NULL in case of error

Function: xmlListSearch

void *	xmlListSearch	(xmlListPtr l, 
void * data)

Search the list for an existing value of @data

l:a list
data:a search value
Returns:the value associated to @data or NULL in case of error

Function: xmlListMerge

void	xmlListMerge	(xmlListPtr l1, 
xmlListPtr l2)

include all the elements of the second list in the first one and clear the second list

l1:the original list
l2:the new list

Daniel Veillard