deps/src/libxml2-2.9.1/doc/html/libxml-xpath.html
| |
|
|
|
|
|
|
|
|
|
| API Menu | |
|
| API Indexes | |
|
| Related links | |
|
|
|
|
|
|
| | xmlwriter | | API documentation | | The XML C parser and toolkit of Gnome | xpathInternals | |
API for the XML Path Language implementation XML Path Language implementation XPath is a language for addressing parts of an XML document, designed to be used by both XSLT and XPointer
#define[XML\_XPATH\_CHECKNS](#XML_XPATH_CHECKNS)
#define[XML\_XPATH\_NOVAR](#XML_XPATH_NOVAR)
#define[xmlXPathNodeSetGetLength](#xmlXPathNodeSetGetLength)
#define[xmlXPathNodeSetIsEmpty](#xmlXPathNodeSetIsEmpty)
#define[xmlXPathNodeSetItem](#xmlXPathNodeSetItem)
Structure[xmlNodeSet](#xmlNodeSet)
struct _xmlNodeSet
Typedef[xmlNodeSet](libxml-xpath.html#xmlNodeSet)*xmlNodeSetPtr
Structure[xmlXPathAxis](#xmlXPathAxis)
struct _xmlXPathAxis
Typedef[xmlXPathAxis](libxml-xpath.html#xmlXPathAxis)*xmlXPathAxisPtr
Structure[xmlXPathCompExpr](#xmlXPathCompExpr)
struct _xmlXPathCompExpr
The content of this structure is not made public by the API.
Typedef[xmlXPathCompExpr](libxml-xpath.html#xmlXPathCompExpr)*xmlXPathCompExprPtr
Structure[xmlXPathContext](#xmlXPathContext)
struct _xmlXPathContext
Typedef[xmlXPathContext](libxml-xpath.html#xmlXPathContext)*xmlXPathContextPtr
Enum[xmlXPathError](#xmlXPathError)
Typedef[xmlXPathFunct](libxml-xpath.html#xmlXPathFunct)*xmlXPathFuncPtr
Structure[xmlXPathFunct](#xmlXPathFunct)
struct _xmlXPathFunct
Structure[xmlXPathObject](#xmlXPathObject)
struct _xmlXPathObject
Typedef[xmlXPathObject](libxml-xpath.html#xmlXPathObject)*xmlXPathObjectPtr
Enum[xmlXPathObjectType](#xmlXPathObjectType)
Structure[xmlXPathParserContext](#xmlXPathParserContext)
struct _xmlXPathParserContext
Typedef[xmlXPathParserContext](libxml-xpath.html#xmlXPathParserContext)*xmlXPathParserContextPtr
Structure[xmlXPathType](#xmlXPathType)
struct _xmlXPathType
Typedef[xmlXPathType](libxml-xpath.html#xmlXPathType)*xmlXPathTypePtr
Structure[xmlXPathVariable](#xmlXPathVariable)
struct _xmlXPathVariable
Typedef[xmlXPathVariable](libxml-xpath.html#xmlXPathVariable)*xmlXPathVariablePtr
Function type:[xmlXPathAxisFunc](#xmlXPathAxisFunc)[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathAxisFunc](#xmlXPathAxisFunc)([xmlXPathParserContextPtr](libxml-xpath.html#xmlXPathParserContextPtr)ctxt,
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)cur)
double[xmlXPathCastBooleanToNumber](#xmlXPathCastBooleanToNumber)(int val)
[xmlChar](libxml-xmlstring.html#xmlChar)*[xmlXPathCastBooleanToString](#xmlXPathCastBooleanToString)(int val)
int[xmlXPathCastNodeSetToBoolean](#xmlXPathCastNodeSetToBoolean)([xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)ns)
double[xmlXPathCastNodeSetToNumber](#xmlXPathCastNodeSetToNumber)([xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)ns)
[xmlChar](libxml-xmlstring.html#xmlChar)*[xmlXPathCastNodeSetToString](#xmlXPathCastNodeSetToString)([xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)ns)
double[xmlXPathCastNodeToNumber](#xmlXPathCastNodeToNumber)([xmlNodePtr](libxml-tree.html#xmlNodePtr)node)
[xmlChar](libxml-xmlstring.html#xmlChar)*[xmlXPathCastNodeToString](#xmlXPathCastNodeToString)([xmlNodePtr](libxml-tree.html#xmlNodePtr)node)
int[xmlXPathCastNumberToBoolean](#xmlXPathCastNumberToBoolean)(double val)
[xmlChar](libxml-xmlstring.html#xmlChar)*[xmlXPathCastNumberToString](#xmlXPathCastNumberToString)(double val)
int[xmlXPathCastStringToBoolean](#xmlXPathCastStringToBoolean)(const[xmlChar](libxml-xmlstring.html#xmlChar)* val)
double[xmlXPathCastStringToNumber](#xmlXPathCastStringToNumber)(const[xmlChar](libxml-xmlstring.html#xmlChar)* val)
int[xmlXPathCastToBoolean](#xmlXPathCastToBoolean)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
double[xmlXPathCastToNumber](#xmlXPathCastToNumber)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
[xmlChar](libxml-xmlstring.html#xmlChar)*[xmlXPathCastToString](#xmlXPathCastToString)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
int[xmlXPathCmpNodes](#xmlXPathCmpNodes)([xmlNodePtr](libxml-tree.html#xmlNodePtr)node1,
[xmlNodePtr](libxml-tree.html#xmlNodePtr)node2)
[xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)[xmlXPathCompile](#xmlXPathCompile)(const[xmlChar](libxml-xmlstring.html#xmlChar)* str)
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathCompiledEval](#xmlXPathCompiledEval)([xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)comp,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctx)
int[xmlXPathCompiledEvalToBoolean](#xmlXPathCompiledEvalToBoolean)([xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)comp,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt)
int[xmlXPathContextSetCache](#xmlXPathContextSetCache)([xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt,
int active,
int value,
int options)
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathConvertBoolean](#xmlXPathConvertBoolean)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
Function type:[xmlXPathConvertFunc](#xmlXPathConvertFunc)int[xmlXPathConvertFunc](#xmlXPathConvertFunc)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)obj,
int type)
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathConvertNumber](#xmlXPathConvertNumber)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathConvertString](#xmlXPathConvertString)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
[xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)[xmlXPathCtxtCompile](#xmlXPathCtxtCompile)([xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt,
const[xmlChar](libxml-xmlstring.html#xmlChar)* str)
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathEval](#xmlXPathEval)(const[xmlChar](libxml-xmlstring.html#xmlChar)* str,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctx)
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathEvalExpression](#xmlXPathEvalExpression)(const[xmlChar](libxml-xmlstring.html#xmlChar)* str,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt)
Function type:[xmlXPathEvalFunc](#xmlXPathEvalFunc)void[xmlXPathEvalFunc](#xmlXPathEvalFunc)([xmlXPathParserContextPtr](libxml-xpath.html#xmlXPathParserContextPtr)ctxt,
int nargs)
int[xmlXPathEvalPredicate](#xmlXPathEvalPredicate)([xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt,
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)res)
void[xmlXPathFreeCompExpr](#xmlXPathFreeCompExpr)([xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)comp)
void[xmlXPathFreeContext](#xmlXPathFreeContext)([xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt)
void[xmlXPathFreeNodeSet](#xmlXPathFreeNodeSet)([xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)obj)
void[xmlXPathFreeNodeSetList](#xmlXPathFreeNodeSetList)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)obj)
void[xmlXPathFreeObject](#xmlXPathFreeObject)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)obj)
Function type:[xmlXPathFuncLookupFunc](#xmlXPathFuncLookupFunc)[xmlXPathFunction](libxml-xpath.html#xmlXPathFunction)[xmlXPathFuncLookupFunc](#xmlXPathFuncLookupFunc)(void * ctxt,
const[xmlChar](libxml-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml-xmlstring.html#xmlChar)* ns_uri)
Function type:[xmlXPathFunction](#xmlXPathFunction)void[xmlXPathFunction](#xmlXPathFunction)([xmlXPathParserContextPtr](libxml-xpath.html#xmlXPathParserContextPtr)ctxt,
int nargs)
void[xmlXPathInit](#xmlXPathInit)(void)
int[xmlXPathIsInf](#xmlXPathIsInf)(double val)
int[xmlXPathIsNaN](#xmlXPathIsNaN)(double val)
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)[xmlXPathNewContext](#xmlXPathNewContext)([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathNodeEval](#xmlXPathNodeEval)([xmlNodePtr](libxml-tree.html#xmlNodePtr)node,
const[xmlChar](libxml-xmlstring.html#xmlChar)* str,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctx)
[xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)[xmlXPathNodeSetCreate](#xmlXPathNodeSetCreate)([xmlNodePtr](libxml-tree.html#xmlNodePtr)val)
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathObjectCopy](#xmlXPathObjectCopy)([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
long[xmlXPathOrderDocElems](#xmlXPathOrderDocElems)([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)
int[xmlXPathSetContextNode](#xmlXPathSetContextNode)([xmlNodePtr](libxml-tree.html#xmlNodePtr)node,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctx)
Function type:[xmlXPathVariableLookupFunc](#xmlXPathVariableLookupFunc)[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)[xmlXPathVariableLookupFunc](#xmlXPathVariableLookupFunc)(void * ctxt,
const[xmlChar](libxml-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml-xmlstring.html#xmlChar)* ns_uri)
#define XML_XPATH_CHECKNS
check namespaces at compilation
#define XML_XPATH_NOVAR
forbid variables in expression
#define xmlXPathNodeSetGetLength
Implement a functionality similar to the DOM NodeList.length. Returns the number of nodes in the node-set.
#define xmlXPathNodeSetIsEmpty
Checks whether @ns is empty or not. Returns %TRUE if @ns is an empty node-set.
#define xmlXPathNodeSetItem
Implements a functionality similar to the DOM NodeList.item(). Returns the xmlNodePtr at the given @index in @ns or NULL if @index is out of range (0 to length-1)
Structure xmlNodeSet
struct _xmlNodeSet {
int nodeNr : number of nodes in the set
int nodeMax : size of the array as allocated[xmlNodePtr](libxml-tree.html#xmlNodePtr)* nodeTab : array of nodes in no particular order @
}
Structure xmlXPathAxis
struct _xmlXPathAxis {
const[xmlChar](libxml-xmlstring.html#xmlChar)* name : the axis name[xmlXPathAxisFunc](libxml-xpath.html#xmlXPathAxisFunc)func : the search function
}
Structure xmlXPathCompExpr
struct _xmlXPathCompExpr {
The content of this structure is not made public by the API.
}
Structure xmlXPathContext
struct _xmlXPathContext {[xmlDocPtr](libxml-tree.html#xmlDocPtr)doc : The current document[xmlNodePtr](libxml-tree.html#xmlNodePtr)node : The current node
int nb_variables_unused : unused (hash table)
int max_variables_unused : unused (hash table)[xmlHashTablePtr](libxml-hash.html#xmlHashTablePtr)varHash : Hash table of defined variables
int nb_types : number of defined types
int max_types : max number of types[xmlXPathTypePtr](libxml-xpath.html#xmlXPathTypePtr)types : Array of defined types
int nb_funcs_unused : unused (hash table)
int max_funcs_unused : unused (hash table)[xmlHashTablePtr](libxml-hash.html#xmlHashTablePtr)funcHash : Hash table of defined funcs
int nb_axis : number of defined axis
int max_axis : max number of axis[xmlXPathAxisPtr](libxml-xpath.html#xmlXPathAxisPtr)axis : Array of defined axis the namespace nod[xmlNsPtr](libxml-tree.html#xmlNsPtr)* namespaces : Array of namespaces
int nsNr : number of namespace in scope
void * user : function to free extra variables
int contextSize : the context size
int proximityPosition : the proximity position extra stuff for
int xptr : is this an XPointer context?[xmlNodePtr](libxml-tree.html#xmlNodePtr)here : for here()[xmlNodePtr](libxml-tree.html#xmlNodePtr)origin : for origin() the set of namespace decla[xmlHashTablePtr](libxml-hash.html#xmlHashTablePtr)nsHash : The namespaces hash table[xmlXPathVariableLookupFunc](libxml-xpath.html#xmlXPathVariableLookupFunc)varLookupFunc : variable lookup func
void * varLookupData : variable lookup data Possibility to lin
void * extra : needed for XSLT The function name and U
const[xmlChar](libxml-xmlstring.html#xmlChar)* function
const[xmlChar](libxml-xmlstring.html#xmlChar)* functionURI : function lookup function and data[xmlXPathFuncLookupFunc](libxml-xpath.html#xmlXPathFuncLookupFunc)funcLookupFunc : function lookup func
void * funcLookupData : function lookup data temporary namespac[xmlNsPtr](libxml-tree.html#xmlNsPtr)* tmpNsList : Array of namespaces
int tmpNsNr : number of namespaces in scope error rep
void * userData : user specific data block[xmlStructuredErrorFunc](libxml-xmlerror.html#xmlStructuredErrorFunc)error : the callback in case of errors[xmlError](libxml-xmlerror.html#xmlError)lastError : the last error[xmlNodePtr](libxml-tree.html#xmlNodePtr)debugNode : the source node XSLT dictionary[xmlDictPtr](libxml-dict.html#xmlDictPtr)dict : dictionary if any
int flags : flags to control compilation Cache for
void * cache
}
Enum xmlXPathError {XPATH\_EXPRESSION\_OK= 0XPATH\_NUMBER\_ERROR= 1XPATH\_UNFINISHED\_LITERAL\_ERROR= 2XPATH\_START\_LITERAL\_ERROR= 3XPATH\_VARIABLE\_REF\_ERROR= 4XPATH\_UNDEF\_VARIABLE\_ERROR= 5XPATH\_INVALID\_PREDICATE\_ERROR= 6XPATH\_EXPR\_ERROR= 7XPATH\_UNCLOSED\_ERROR= 8XPATH\_UNKNOWN\_FUNC\_ERROR= 9XPATH\_INVALID\_OPERAND= 10XPATH\_INVALID\_TYPE= 11XPATH\_INVALID\_ARITY= 12XPATH\_INVALID\_CTXT\_SIZE= 13XPATH\_INVALID\_CTXT\_POSITION= 14XPATH\_MEMORY\_ERROR= 15XPTR\_SYNTAX\_ERROR= 16XPTR\_RESOURCE\_ERROR= 17XPTR\_SUB\_RESOURCE\_ERROR= 18XPATH\_UNDEF\_PREFIX\_ERROR= 19XPATH\_ENCODING\_ERROR= 20XPATH\_INVALID\_CHAR\_ERROR= 21XPATH\_INVALID\_CTXT= 22XPATH\_STACK\_ERROR= 23XPATH\_FORBID\_VARIABLE\_ERROR= 24
}
Structure xmlXPathFunct
struct _xmlXPathFunct {
const[xmlChar](libxml-xmlstring.html#xmlChar)* name : the function name[xmlXPathEvalFunc](libxml-xpath.html#xmlXPathEvalFunc)func : the evaluation function
}
Structure xmlXPathObject
struct _xmlXPathObject {[xmlXPathObjectType](libxml-xpath.html#xmlXPathObjectType)type[xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)nodesetval
int boolval
double floatval[xmlChar](libxml-xmlstring.html#xmlChar)* stringval
void * user
int index
void * user2
int index2
}
Enum xmlXPathObjectType {XPATH\_UNDEFINED= 0XPATH\_NODESET= 1XPATH\_BOOLEAN= 2XPATH\_NUMBER= 3XPATH\_STRING= 4XPATH\_POINT= 5XPATH\_RANGE= 6XPATH\_LOCATIONSET= 7XPATH\_USERS= 8XPATH\_XSLT\_TREE= 9 : An XSLT value tree, non modifiable
}
Structure xmlXPathParserContext
struct _xmlXPathParserContext {
const[xmlChar](libxml-xmlstring.html#xmlChar)* cur : the current char being parsed
const[xmlChar](libxml-xmlstring.html#xmlChar)* base : the full expression
int error : error code[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)context : the evaluation context[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)value : the current value
int valueNr : number of values stacked
int valueMax : max number of values stacked[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)* valueTab : stack of values[xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)comp : the precompiled expression
int xptr : it this an XPointer expression[xmlNodePtr](libxml-tree.html#xmlNodePtr)ancestor : used for walking preceding axis
int valueFrame : used to limit Pop on the stack
}
Structure xmlXPathType
struct _xmlXPathType {
const[xmlChar](libxml-xmlstring.html#xmlChar)* name : the type name[xmlXPathConvertFunc](libxml-xpath.html#xmlXPathConvertFunc)func : the conversion function
}
Structure xmlXPathVariable
struct _xmlXPathVariable {
const[xmlChar](libxml-xmlstring.html#xmlChar)* name : the variable name[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)value : the value
}
Function type: xmlXPathAxisFunc[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathAxisFunc ([xmlXPathParserContextPtr](libxml-xpath.html#xmlXPathParserContextPtr)ctxt,
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)cur)
An axis traversal function. To traverse an axis, the engine calls the first time with cur == NULL and repeat until the function returns NULL indicating the end of the axis traversal.
| ctxt: | the XPath interpreter context | | cur: | the previous node being explored on that axis | | Returns: | the next node in that axis or NULL if at the end of the axis. |
double xmlXPathCastBooleanToNumber (int val)
Converts a boolean to its number value
| val: | a boolean | | Returns: | the number value |
[xmlChar](libxml-xmlstring.html#xmlChar)* xmlXPathCastBooleanToString (int val)
Converts a boolean to its string value.
| val: | a boolean | | Returns: | a newly allocated string. |
int xmlXPathCastNodeSetToBoolean ([xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)ns)
Converts a node-set to its boolean value
| ns: | a node-set | | Returns: | the boolean value |
double xmlXPathCastNodeSetToNumber ([xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)ns)
Converts a node-set to its number value
| ns: | a node-set | | Returns: | the number value |
[xmlChar](libxml-xmlstring.html#xmlChar)* xmlXPathCastNodeSetToString ([xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)ns)
Converts a node-set to its string value.
| ns: | a node-set | | Returns: | a newly allocated string. |
double xmlXPathCastNodeToNumber ([xmlNodePtr](libxml-tree.html#xmlNodePtr)node)
Converts a node to its number value
| node: | a node | | Returns: | the number value |
[xmlChar](libxml-xmlstring.html#xmlChar)* xmlXPathCastNodeToString ([xmlNodePtr](libxml-tree.html#xmlNodePtr)node)
Converts a node to its string value.
| node: | a node | | Returns: | a newly allocated string. |
int xmlXPathCastNumberToBoolean (double val)
Converts a number to its boolean value
| val: | a number | | Returns: | the boolean value |
[xmlChar](libxml-xmlstring.html#xmlChar)* xmlXPathCastNumberToString (double val)
Converts a number to its string value.
| val: | a number | | Returns: | a newly allocated string. |
int xmlXPathCastStringToBoolean (const[xmlChar](libxml-xmlstring.html#xmlChar)* val)
Converts a string to its boolean value
| val: | a string | | Returns: | the boolean value |
double xmlXPathCastStringToNumber (const[xmlChar](libxml-xmlstring.html#xmlChar)* val)
Converts a string to its number value
| val: | a string | | Returns: | the number value |
int xmlXPathCastToBoolean ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
Converts an XPath object to its boolean value
| val: | an XPath object | | Returns: | the boolean value |
double xmlXPathCastToNumber ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
Converts an XPath object to its number value
| val: | an XPath object | | Returns: | the number value |
[xmlChar](libxml-xmlstring.html#xmlChar)* xmlXPathCastToString ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
Converts an existing object to its string() equivalent
| val: | an XPath object | | Returns: | the allocated string value of the object, NULL in case of error. It's up to the caller to free the string memory with xmlFree(). |
int xmlXPathCmpNodes ([xmlNodePtr](libxml-tree.html#xmlNodePtr)node1,
[xmlNodePtr](libxml-tree.html#xmlNodePtr)node2)
Compare two nodes w.r.t document order
| node1: | the first node | | node2: | the second node | | Returns: | -2 in case of error 1 if first point < second point, 0 if it's the same node, -1 otherwise |
[xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)xmlXPathCompile (const[xmlChar](libxml-xmlstring.html#xmlChar)* str)
Compile an XPath expression
| str: | the XPath expression | | Returns: | the xmlXPathCompExprPtr resulting from the compilation or NULL. the caller has to free the object. |
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathCompiledEval ([xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)comp,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctx)
Evaluate the Precompiled XPath expression in the given context.
| comp: | the compiled XPath expression | | ctx: | the XPath context | | Returns: | the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object. |
int xmlXPathCompiledEvalToBoolean ([xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)comp,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt)
Applies the XPath boolean() function on the result of the given compiled expression.
| comp: | the compiled XPath expression | | ctxt: | the XPath context | | Returns: | 1 if the expression evaluated to true, 0 if to false and -1 in API and internal errors. |
int xmlXPathContextSetCache ([xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt,
int active,
int value,
int options)
Creates/frees an object cache on the XPath context. If activates XPath objects (xmlXPathObject) will be cached internally to be reused. @options: 0: This will set the XPath object caching: @value: This will set the maximum number of XPath objects to be cached per slot There are 5 slots for: node-set, string, number, boolean, and misc objects. Use <0 for the default number (100). Other values for @options have currently no effect.
| ctxt: | the XPath context | | active: | enables/disables (creates/frees) the cache | | value: | a value with semantics dependant on @options | | options: | options (currently only the value 0 is used) | | Returns: | 0 if the setting succeeded, and -1 on API or internal errors. |
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathConvertBoolean ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
Converts an existing object to its boolean() equivalent
| val: | an XPath object | | Returns: | the new object, the old one is freed (or the operation is done directly on @val) |
Function type: xmlXPathConvertFunc
int xmlXPathConvertFunc ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)obj,
int type)
A conversion function is associated to a type and used to cast the new type to primitive values.
| obj: | an XPath object | | type: | the number of the target type | | Returns: | -1 in case of error, 0 otherwise |
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathConvertNumber ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
Converts an existing object to its number() equivalent
| val: | an XPath object | | Returns: | the new object, the old one is freed (or the operation is done directly on @val) |
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathConvertString ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
Converts an existing object to its string() equivalent
| val: | an XPath object | | Returns: | the new object, the old one is freed (or the operation is done directly on @val) |
[xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)xmlXPathCtxtCompile ([xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt,
const[xmlChar](libxml-xmlstring.html#xmlChar)* str)
Compile an XPath expression
| ctxt: | an XPath context | | str: | the XPath expression | | Returns: | the xmlXPathCompExprPtr resulting from the compilation or NULL. the caller has to free the object. |
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathEval (const[xmlChar](libxml-xmlstring.html#xmlChar)* str,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctx)
Evaluate the XPath Location Path in the given context.
| str: | the XPath expression | | ctx: | the XPath context | | Returns: | the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object. |
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathEvalExpression (const[xmlChar](libxml-xmlstring.html#xmlChar)* str,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt)
Evaluate the XPath expression in the given context.
| str: | the XPath expression | | ctxt: | the XPath context | | Returns: | the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object. |
Function type: xmlXPathEvalFunc
void xmlXPathEvalFunc ([xmlXPathParserContextPtr](libxml-xpath.html#xmlXPathParserContextPtr)ctxt,
int nargs)
An XPath evaluation function, the parameters are on the XPath context stack.
| ctxt: | an XPath parser context | | nargs: | the number of arguments passed to the function |
int xmlXPathEvalPredicate ([xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt,
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)res)
Evaluate a predicate result for the current node. A PredicateExpr is evaluated by evaluating the Expr and converting the result to a boolean. If the result is a number, the result will be converted to true if the number is equal to the position of the context node in the context node list (as returned by the position function) and will be converted to false otherwise; if the result is not a number, then the result will be converted as if by a call to the boolean function.
| ctxt: | the XPath context | | res: | the Predicate Expression evaluation result | | Returns: | 1 if predicate is true, 0 otherwise |
void xmlXPathFreeCompExpr ([xmlXPathCompExprPtr](libxml-xpath.html#xmlXPathCompExprPtr)comp)
Free up the memory allocated by @comp
| comp: | an XPATH comp |
void xmlXPathFreeContext ([xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctxt)
Free up an xmlXPathContext
| ctxt: | the context to free |
void xmlXPathFreeNodeSet ([xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)obj)
Free the NodeSet compound (not the actual nodes !).
| obj: | the xmlNodeSetPtr to free |
void xmlXPathFreeNodeSetList ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)obj)
Free up the xmlXPathObjectPtr @obj but don't deallocate the objects in the list contrary to xmlXPathFreeObject().
| obj: | an existing NodeSetList object |
void xmlXPathFreeObject ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)obj)
Free up an xmlXPathObjectPtr object.
| obj: | the object to free |
Function type: xmlXPathFuncLookupFunc[xmlXPathFunction](libxml-xpath.html#xmlXPathFunction)xmlXPathFuncLookupFunc (void * ctxt,
const[xmlChar](libxml-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml-xmlstring.html#xmlChar)* ns_uri)
Prototype for callbacks used to plug function lookup in the XPath engine.
| ctxt: | an XPath context | | name: | name of the function | | ns_uri: | the namespace name hosting this function | | Returns: | the XPath function or NULL if not found. |
Function type: xmlXPathFunction
void xmlXPathFunction ([xmlXPathParserContextPtr](libxml-xpath.html#xmlXPathParserContextPtr)ctxt,
int nargs)
An XPath function. The arguments (if any) are popped out from the context stack and the result is pushed on the stack.
| ctxt: | the XPath interprestation context | | nargs: | the number of arguments |
void xmlXPathInit (void)
Initialize the XPath environment
int xmlXPathIsInf (double val)
Provides a portable isinf() function to detect whether a double is a +Infinite or -Infinite. Based on trio code http://sourceforge.net/projects/ctrio/
| val: | a double value | | Returns: | 1 vi the value is +Infinite, -1 if -Infinite, 0 otherwise |
int xmlXPathIsNaN (double val)
Provides a portable isnan() function to detect whether a double is a NotaNumber. Based on trio code http://sourceforge.net/projects/ctrio/
| val: | a double value | | Returns: | 1 if the value is a NaN, 0 otherwise |
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)xmlXPathNewContext ([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)
Create a new xmlXPathContext
| doc: | the XML document | | Returns: | the xmlXPathContext just allocated. The caller will need to free it. |
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathNodeEval ([xmlNodePtr](libxml-tree.html#xmlNodePtr)node,
const[xmlChar](libxml-xmlstring.html#xmlChar)* str,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctx)
Evaluate the XPath Location Path in the given context. The node 'node' is set as the context node. The context node is not restored.
| node: | the node to to use as the context node | | str: | the XPath expression | | ctx: | the XPath context | | Returns: | the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object. |
[xmlNodeSetPtr](libxml-xpath.html#xmlNodeSetPtr)xmlXPathNodeSetCreate ([xmlNodePtr](libxml-tree.html#xmlNodePtr)val)
Create a new xmlNodeSetPtr of type double and of value @val
| val: | an initial xmlNodePtr, or NULL | | Returns: | the newly created object. |
[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathObjectCopy ([xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)val)
allocate a new copy of a given object
| val: | the original object | | Returns: | the newly created object. |
long xmlXPathOrderDocElems ([xmlDocPtr](libxml-tree.html#xmlDocPtr)doc)
Call this routine to speed up XPath computation on static documents. This stamps all the element nodes with the document order Like for line information, the order is kept in the element->content field, the value stored is actually - the node number (starting at -1) to be able to differentiate from line numbers.
| doc: | an input document | | Returns: | the number of elements found in the document or -1 in case of error. |
int xmlXPathSetContextNode ([xmlNodePtr](libxml-tree.html#xmlNodePtr)node,
[xmlXPathContextPtr](libxml-xpath.html#xmlXPathContextPtr)ctx)
Sets 'node' as the context node. The node must be in the same document as that associated with the context.
| node: | the node to to use as the context node | | ctx: | the XPath context | | Returns: | -1 in case of error or 0 if successful |
Function type: xmlXPathVariableLookupFunc[xmlXPathObjectPtr](libxml-xpath.html#xmlXPathObjectPtr)xmlXPathVariableLookupFunc (void * ctxt,
const[xmlChar](libxml-xmlstring.html#xmlChar)* name,
const[xmlChar](libxml-xmlstring.html#xmlChar)* ns_uri)
Prototype for callbacks used to plug variable lookup in the XPath engine.
| ctxt: | an XPath context | | name: | name of the variable | | ns_uri: | the namespace name hosting this variable | | Returns: | the XPath object value or NULL if not found. |
|
|
|
|
|