source-git / libxml2

Clone
Source Code
GIT

Blame doc/html/libxml-list.html

c8 c8s master
  1.   c8
  2.   doc
  3.   html
  4.   libxml-list.html
Blob History Raw
Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6 
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="SHORTCUT ICON" href="/favicon.ico" /><style type="text/css">
Packit Service a31ea6 
TD {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6 
BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
Packit Service a31ea6 
H1 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6 
H2 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6 
H3 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6 
A:link, A:visited, A:active { text-decoration: underline }
Packit Service a31ea6 
</style><style type="text/css">
Packit Service a31ea6 
      div.deprecated pre.programlisting {border-style: double;border-color:red}
Packit Service a31ea6 
      pre.programlisting {border-style: double;background: #EECFA1}
Packit Service a31ea6 
    </style><title>Module list from libxml2</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000">
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module list from libxml2
<center>API Menu</center>
<form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="20" value="" /><input name="submit" type="submit" value="Search ..." /></form>
<center>API Indexes</center>
<center>Related links</center>
PrevhashUpAPI documentationHomeThe XML C parser and toolkit of GnomenanoftpNext
this module implement the list support used in various place in the library. 
Table of Contents
Structure xmlLink
struct _xmlLink
Packit Service a31ea6 
The content of this structure is not made public by the API.
Packit Service a31ea6 
Typedef xmlLink * xmlLinkPtr
Packit Service a31ea6 
Structure xmlList
struct _xmlList
Packit Service a31ea6 
The content of this structure is not made public by the API.
Packit Service a31ea6 
Typedef xmlList * xmlListPtr
Packit Service a31ea6 
void *	xmlLinkGetData			(xmlLinkPtr lk)
Packit Service a31ea6 
int	xmlListAppend			(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
void	xmlListClear			(xmlListPtr l)
Packit Service a31ea6 
int	xmlListCopy			(xmlListPtr cur, 
					 const xmlListPtr old)
Packit Service a31ea6 
xmlListPtr	xmlListCreate		(xmlListDeallocator deallocator, 
					 xmlListDataCompare compare)
Packit Service a31ea6 
Function type: xmlListDataCompare
Packit Service a31ea6 
int	xmlListDataCompare		(const void * data0, 
					 const void * data1)
Packit Service a31ea6
Packit Service a31ea6 
Function type: xmlListDeallocator
Packit Service a31ea6 
void	xmlListDeallocator		(xmlLinkPtr lk)
Packit Service a31ea6
Packit Service a31ea6 
void	xmlListDelete			(xmlListPtr l)
Packit Service a31ea6 
xmlListPtr	xmlListDup		(const xmlListPtr old)
Packit Service a31ea6 
int	xmlListEmpty			(xmlListPtr l)
Packit Service a31ea6 
xmlLinkPtr	xmlListEnd		(xmlListPtr l)
Packit Service a31ea6 
xmlLinkPtr	xmlListFront		(xmlListPtr l)
Packit Service a31ea6 
int	xmlListInsert			(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
void	xmlListMerge			(xmlListPtr l1, 
					 xmlListPtr l2)
Packit Service a31ea6 
void	xmlListPopBack			(xmlListPtr l)
Packit Service a31ea6 
void	xmlListPopFront			(xmlListPtr l)
Packit Service a31ea6 
int	xmlListPushBack			(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
int	xmlListPushFront		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
int	xmlListRemoveAll		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
int	xmlListRemoveFirst		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
int	xmlListRemoveLast		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
void	xmlListReverse			(xmlListPtr l)
Packit Service a31ea6 
void *	xmlListReverseSearch		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
void	xmlListReverseWalk		(xmlListPtr l, 
					 xmlListWalker walker, 
					 const void * user)
Packit Service a31ea6 
void *	xmlListSearch			(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
int	xmlListSize			(xmlListPtr l)
Packit Service a31ea6 
void	xmlListSort			(xmlListPtr l)
Packit Service a31ea6 
void	xmlListWalk			(xmlListPtr l, 
					 xmlListWalker walker, 
					 const void * user)
Packit Service a31ea6 
Function type: xmlListWalker
Packit Service a31ea6 
int	xmlListWalker			(const void * data, 
					 const void * user)
Packit Service a31ea6
Packit Service a31ea6 
Description
Packit Service a31ea6 
Structure xmlLink
Structure xmlLink
struct _xmlLink {
Packit Service a31ea6 
The content of this structure is not made public by the API.
Packit Service a31ea6 
}
Structure xmlList
Structure xmlList
struct _xmlList {
Packit Service a31ea6 
The content of this structure is not made public by the API.
Packit Service a31ea6 
}
Function: xmlLinkGetData
void *	xmlLinkGetData			(xmlLinkPtr lk)
Packit Service a31ea6 
See Returns.
Packit Service a31ea6 
<tt>lk</tt>:a link
<tt>Returns</tt>:a pointer to the data referenced from this link
Function: xmlListAppend
int	xmlListAppend			(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
Insert data in the ordered list at the end for this value
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:the data
<tt>Returns</tt>:0 in case of success, 1 in case of failure
Function: xmlListClear
void	xmlListClear			(xmlListPtr l)
Packit Service a31ea6 
Remove the all data in the list
Packit Service a31ea6 
<tt>l</tt>:a list
Function: xmlListCopy
int	xmlListCopy			(xmlListPtr cur, 
					 const xmlListPtr old)
Packit Service a31ea6 
Move all the element from the old list in the new list
Packit Service a31ea6 
<tt>cur</tt>:the new list
<tt>old</tt>:the old list
<tt>Returns</tt>:0 in case of success 1 in case of error
Function: xmlListCreate
xmlListPtr	xmlListCreate		(xmlListDeallocator deallocator, 
					 xmlListDataCompare compare)
Packit Service a31ea6 
Create a new list
Packit Service a31ea6 
<tt>deallocator</tt>:an optional deallocator function
<tt>compare</tt>:an optional comparison function
<tt>Returns</tt>:the new list or NULL in case of error
Function type: xmlListDataCompare
Function type: xmlListDataCompare
Packit Service a31ea6 
int	xmlListDataCompare		(const void * data0, 
					 const void * data1)
Packit Service a31ea6 
Callback function used to compare 2 data.
<tt>data0</tt>:the first data
<tt>data1</tt>:the second data
<tt>Returns</tt>:0 is equality, -1 or 1 otherwise depending on the ordering.
Packit Service a31ea6 
Function type: xmlListDeallocator
Function type: xmlListDeallocator
Packit Service a31ea6 
void	xmlListDeallocator		(xmlLinkPtr lk)
Packit Service a31ea6 
Callback function used to free data from a list.
<tt>lk</tt>:the data to deallocate
Packit Service a31ea6 
Function: xmlListDelete
void	xmlListDelete			(xmlListPtr l)
Packit Service a31ea6 
Deletes the list and its associated data
Packit Service a31ea6 
<tt>l</tt>:a list
Function: xmlListDup
xmlListPtr	xmlListDup		(const xmlListPtr old)
Packit Service a31ea6 
Duplicate the list
Packit Service a31ea6 
<tt>old</tt>:the list
<tt>Returns</tt>:a new copy of the list or NULL in case of error
Function: xmlListEmpty
int	xmlListEmpty			(xmlListPtr l)
Packit Service a31ea6 
Is the list empty ?
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>Returns</tt>:1 if the list is empty, 0 if not empty and -1 in case of error
Function: xmlListEnd
xmlLinkPtr	xmlListEnd		(xmlListPtr l)
Packit Service a31ea6 
Get the last element in the list
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>Returns</tt>:the last element in the list, or NULL
Function: xmlListFront
xmlLinkPtr	xmlListFront		(xmlListPtr l)
Packit Service a31ea6 
Get the first element in the list
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>Returns</tt>:the first element in the list, or NULL
Function: xmlListInsert
int	xmlListInsert			(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
Insert data in the ordered list at the beginning for this value
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:the data
<tt>Returns</tt>:0 in case of success, 1 in case of failure
Function: xmlListMerge
void	xmlListMerge			(xmlListPtr l1, 
					 xmlListPtr l2)
Packit Service a31ea6 
include all the elements of the second list in the first one and clear the second list
Packit Service a31ea6 
<tt>l1</tt>:the original list
<tt>l2</tt>:the new list
Function: xmlListPopBack
void	xmlListPopBack			(xmlListPtr l)
Packit Service a31ea6 
Removes the last element in the list
Packit Service a31ea6 
<tt>l</tt>:a list
Function: xmlListPopFront
void	xmlListPopFront			(xmlListPtr l)
Packit Service a31ea6 
Removes the first element in the list
Packit Service a31ea6 
<tt>l</tt>:a list
Function: xmlListPushBack
int	xmlListPushBack			(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
add the new data at the end of the list
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:new data
<tt>Returns</tt>:1 if successful, 0 otherwise
Function: xmlListPushFront
int	xmlListPushFront		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
add the new data at the beginning of the list
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:new data
<tt>Returns</tt>:1 if successful, 0 otherwise
Function: xmlListRemoveAll
int	xmlListRemoveAll		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
Remove the all instance associated to data in the list
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:list data
<tt>Returns</tt>:the number of deallocation, or 0 if not found
Function: xmlListRemoveFirst
int	xmlListRemoveFirst		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
Remove the first instance associated to data in the list
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:list data
<tt>Returns</tt>:1 if a deallocation occurred, or 0 if not found
Function: xmlListRemoveLast
int	xmlListRemoveLast		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
Remove the last instance associated to data in the list
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:list data
<tt>Returns</tt>:1 if a deallocation occurred, or 0 if not found
Function: xmlListReverse
void	xmlListReverse			(xmlListPtr l)
Packit Service a31ea6 
Reverse the order of the elements in the list
Packit Service a31ea6 
<tt>l</tt>:a list
Function: xmlListReverseSearch
void *	xmlListReverseSearch		(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
Search the list in reverse order for an existing value of @data
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:a search value
<tt>Returns</tt>:the value associated to @data or NULL in case of error
Function: xmlListReverseWalk
void	xmlListReverseWalk		(xmlListPtr l, 
					 xmlListWalker walker, 
					 const void * user)
Packit Service a31ea6 
Walk all the element of the list in reverse order and apply the walker function to it
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>walker</tt>:a processing function
<tt>user</tt>:a user parameter passed to the walker function
Function: xmlListSearch
void *	xmlListSearch			(xmlListPtr l, 
					 void * data)
Packit Service a31ea6 
Search the list for an existing value of @data
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>data</tt>:a search value
<tt>Returns</tt>:the value associated to @data or NULL in case of error
Function: xmlListSize
int	xmlListSize			(xmlListPtr l)
Packit Service a31ea6 
Get the number of elements in the list
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>Returns</tt>:the number of elements in the list or -1 in case of error
Function: xmlListSort
void	xmlListSort			(xmlListPtr l)
Packit Service a31ea6 
Sort all the elements in the list
Packit Service a31ea6 
<tt>l</tt>:a list
Function: xmlListWalk
void	xmlListWalk			(xmlListPtr l, 
					 xmlListWalker walker, 
					 const void * user)
Packit Service a31ea6 
Walk all the element of the first from first to last and apply the walker function to it
Packit Service a31ea6 
<tt>l</tt>:a list
<tt>walker</tt>:a processing function
<tt>user</tt>:a user parameter passed to the walker function
Function type: xmlListWalker
Function type: xmlListWalker
Packit Service a31ea6 
int	xmlListWalker			(const void * data, 
					 const void * user)
Packit Service a31ea6 
Callback function used when walking a list with xmlListWalk().
<tt>data</tt>:the data found in the list
<tt>user</tt>:extra user provided data to the walker
<tt>Returns</tt>:0 to stop walking the list, 1 otherwise.
Packit Service a31ea6 
Daniel Veillard
</body></html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation