1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
<title>Axis2/C: api</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
7
<!-- Generated by Doxygen 1.5.3 -->
10
<li><a href="index.html"><span>Main Page</span></a></li>
11
<li><a href="modules.html"><span>Modules</span></a></li>
12
<li><a href="annotated.html"><span>Classes</span></a></li>
13
<li><a href="files.html"><span>Files</span></a></li>
14
<li><a href="dirs.html"><span>Directories</span></a></li>
15
<li><a href="pages.html"><span>Related Pages</span></a></li>
16
<li><a href="examples.html"><span>Examples</span></a></li>
18
<form action="search.php" method="get">
19
<table cellspacing="0" cellpadding="0" border="0">
21
<td><label> <u>S</u>earch for </label></td>
22
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
29
<h1>api</h1><table border="0" cellpadding="0" cellspacing="0">
31
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
32
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression</a></td></tr>
34
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context</a></td></tr>
36
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result</a></td></tr>
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node</a></td></tr>
40
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g27553a5a92aa57f6fb905367f9e950a5">AXIOM_XPATH_DEBUG</a></td></tr>
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g7a66629a5a092f0d5514c34d5575c753">AXIOM_XPATH_EVALUATION_ERROR</a> 0</td></tr>
45
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4a95eb72761a50fd76c58f61040dd703"></a><!-- doxytag: member="axiom_xpath_api::AXIOM_XPATH_ERROR_STREAMING_NOT_SUPPORTED" ref="g4a95eb72761a50fd76c58f61040dd703" args="" -->
46
#define </td><td class="memItemRight" valign="bottom"><b>AXIOM_XPATH_ERROR_STREAMING_NOT_SUPPORTED</b> 10</td></tr>
48
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
49
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <br>
50
<a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g064994aadf8d1c9a29e2be75a84bf0fe">axiom_xpath_expression_t</a></td></tr>
52
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <br>
53
<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g82ac95df86678723508c6b4fdda1febb">axiom_xpath_context_t</a></td></tr>
55
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <br>
56
<a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#gd3fd9cff34578fc31d6ebd4d594a87f7">axiom_xpath_result_t</a></td></tr>
58
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <br>
59
<a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g3ee61d21a66efdb14f7609b79e7c0002">axiom_xpath_result_node_t</a></td></tr>
61
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g38e64c9e22325dcc0750e0f32ef0417a"></a><!-- doxytag: member="axiom_xpath_api::axiom_xpath_function_t" ref="g38e64c9e22325dcc0750e0f32ef0417a" args=")(axiom_xpath_context_t *context, int np)" -->
62
typedef int(* </td><td class="memItemRight" valign="bottom"><b>axiom_xpath_function_t</b> )(<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context, int np)</td></tr>
64
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
65
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#gc71f49207aafbf3bc545c23a8f094c6f">axiom_xpath_result_type_t</a> { <br>
66
<b>AXIOM_XPATH_TYPE_NODE</b> = 0,
67
<b>AXIOM_XPATH_TYPE_ATTRIBUTE</b>,
68
<b>AXIOM_XPATH_TYPE_NAMESPACE</b>,
69
<b>AXIOM_XPATH_TYPE_TEXT</b>,
71
<b>AXIOM_XPATH_TYPE_NUMBER</b>,
72
<b>AXIOM_XPATH_TYPE_BOOLEAN</b>
76
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
77
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN <br>
78
<a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g34b8a60579233870162ebf5d416dc3ac">axiom_xpath_compile_expression</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, const axis2_char_t *xpath_expr)</td></tr>
80
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN <br>
81
<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g9835edaade1499c3f3f22a1028e841ff">axiom_xpath_context_create</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, axiom_node_t *root_node)</td></tr>
83
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN <br>
84
<a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g2012e8e16e51b0d9aec32d85ae12a61a">axiom_xpath_evaluate</a> (<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context, <a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> *xpath_expr)</td></tr>
86
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_bool_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#gc2019dd703c5522ea3373e3e061ada47">axiom_xpath_cast_node_to_boolean</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, <a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> *node)</td></tr>
88
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#ge9336d53cde0e884f5fb213b9df02674">axiom_xpath_cast_node_to_number</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, <a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> *node)</td></tr>
90
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN <br>
91
axis2_char_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g326af499dbf89b48595f9f8464472488">axiom_xpath_cast_node_to_string</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, <a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> *node)</td></tr>
93
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN <br>
94
axiom_node_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#gff7f77f32a203e90418d1e920f5ab30d">axiom_xpath_cast_node_to_axiom_node</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, <a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> *node)</td></tr>
96
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g9c605179eff1ce688aeed2bb3a5a615f">axiom_xpath_free_context</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, <a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context)</td></tr>
98
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g5c75692634a5b8c50aa215838164873c">axiom_xpath_free_expression</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, <a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> *xpath_expr)</td></tr>
100
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#gbce6df5e417ac892e3c472a9e8d9b159">axiom_xpath_free_result</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, <a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result_t</a> *result)</td></tr>
102
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g521831b95af07a1d758870955e21ec46">axiom_xpath_register_namespace</a> (<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context, axiom_namespace_t *ns)</td></tr>
104
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN <br>
105
axiom_namespace_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g81ba6657a1992f1b45a0930f7a413b68">axiom_xpath_get_namespace</a> (<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context, axis2_char_t *prefix)</td></tr>
107
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g3c28eba21a5183ab268021129d9cad12">axiom_xpath_clear_namespaces</a> (<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context)</td></tr>
109
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN <br>
110
<a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g1cd43a5e6fb152d14a218f923418f8d6">axiom_xpath_evaluate_streaming</a> (<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context, <a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> *xpath_expr)</td></tr>
112
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_bool_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g83c7017c40dd0977276b77d97cbff6a5">axiom_xpath_streaming_check</a> (const <a class="el" href="structaxutil__env.html">axutil_env_t</a> *env, <a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> *expr)</td></tr>
114
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#gaa194fb637ad142a32510933243ddda5">axiom_xpath_register_default_functions_set</a> (<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context)</td></tr>
116
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#gb6cc87a2fa3c5adf9d7844d21e2f747b">axiom_xpath_register_function</a> (<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context, axis2_char_t *name, axiom_xpath_function_t func)</td></tr>
118
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN <br>
119
axiom_xpath_function_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__axiom__xpath__api.html#g0cff83ae01a93dfd36978407b9895399">axiom_xpath_get_function</a> (<a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> *context, axis2_char_t *name)</td></tr>
122
<hr><h2>Define Documentation</h2>
123
<a class="anchor" name="g27553a5a92aa57f6fb905367f9e950a5"></a><!-- doxytag: member="axiom_xpath.h::AXIOM_XPATH_DEBUG" ref="g27553a5a92aa57f6fb905367f9e950a5" args="" -->
124
<div class="memitem">
125
<div class="memproto">
126
<table class="memname">
128
<td class="memname">#define AXIOM_XPATH_DEBUG </td>
138
<a class="anchor" name="g7a66629a5a092f0d5514c34d5575c753"></a><!-- doxytag: member="axiom_xpath.h::AXIOM_XPATH_EVALUATION_ERROR" ref="g7a66629a5a092f0d5514c34d5575c753" args="" -->
139
<div class="memitem">
140
<div class="memproto">
141
<table class="memname">
143
<td class="memname">#define AXIOM_XPATH_EVALUATION_ERROR 0 </td>
150
An error occured while evaluating the xpath expression
153
<hr><h2>Typedef Documentation</h2>
154
<a class="anchor" name="g82ac95df86678723508c6b4fdda1febb"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_context_t" ref="g82ac95df86678723508c6b4fdda1febb" args="" -->
155
<div class="memitem">
156
<div class="memproto">
157
<table class="memname">
159
<td class="memname">typedef struct <a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context</a> <a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> </td>
166
The XPath context Keeps a reference to the context node or attribute, XPath expression, environment and result set.
169
<a class="anchor" name="g064994aadf8d1c9a29e2be75a84bf0fe"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_expression_t" ref="g064994aadf8d1c9a29e2be75a84bf0fe" args="" -->
170
<div class="memitem">
171
<div class="memproto">
172
<table class="memname">
174
<td class="memname">typedef struct <a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression</a> <a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> </td>
181
XPath expression It includes the expression as a string and parsed data.
184
<a class="anchor" name="g3ee61d21a66efdb14f7609b79e7c0002"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_result_node_t" ref="g3ee61d21a66efdb14f7609b79e7c0002" args="" -->
185
<div class="memitem">
186
<div class="memproto">
187
<table class="memname">
189
<td class="memname">typedef struct <a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node</a> <a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> </td>
196
XPath result Stores type and value of the result.
199
<a class="anchor" name="gd3fd9cff34578fc31d6ebd4d594a87f7"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_result_t" ref="gd3fd9cff34578fc31d6ebd4d594a87f7" args="" -->
200
<div class="memitem">
201
<div class="memproto">
202
<table class="memname">
204
<td class="memname">typedef struct <a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result</a> <a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result_t</a> </td>
211
XPath result set Contains the result set and other information such as whether the expression was evaluated successfully.
214
<hr><h2>Enumeration Type Documentation</h2>
215
<a class="anchor" name="gc71f49207aafbf3bc545c23a8f094c6f"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_result_type_t" ref="gc71f49207aafbf3bc545c23a8f094c6f" args="" -->
216
<div class="memitem">
217
<div class="memproto">
218
<table class="memname">
220
<td class="memname">enum <a class="el" href="group__axiom__xpath__api.html#gc71f49207aafbf3bc545c23a8f094c6f">axiom_xpath_result_type_t</a> </td>
230
<hr><h2>Function Documentation</h2>
231
<a class="anchor" name="gff7f77f32a203e90418d1e920f5ab30d"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_cast_node_to_axiom_node" ref="gff7f77f32a203e90418d1e920f5ab30d" args="(const axutil_env_t *env, axiom_xpath_result_node_t *node)" -->
232
<div class="memitem">
233
<div class="memproto">
234
<table class="memname">
236
<td class="memname">AXIS2_EXTERN axiom_node_t* axiom_xpath_cast_node_to_axiom_node </td>
238
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
239
<td class="paramname"> <em>env</em>, </td>
242
<td class="paramkey"></td>
244
<td class="paramtype"><a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> * </td>
245
<td class="paramname"> <em>node</em></td><td> </td>
250
<td></td><td></td><td width="100%"></td>
257
Convert an XPath result to an axiom node. If the result is an axiom node it is returned and NULL otherwise.<p>
258
<dl compact><dt><b>Parameters:</b></dt><dd>
259
<table border="0" cellspacing="2" cellpadding="0">
260
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
261
<tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>A pointer to the XPath result </td></tr>
264
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The axiom node. </dd></dl>
268
<a class="anchor" name="gc2019dd703c5522ea3373e3e061ada47"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_cast_node_to_boolean" ref="gc2019dd703c5522ea3373e3e061ada47" args="(const axutil_env_t *env, axiom_xpath_result_node_t *node)" -->
269
<div class="memitem">
270
<div class="memproto">
271
<table class="memname">
273
<td class="memname">AXIS2_EXTERN axis2_bool_t axiom_xpath_cast_node_to_boolean </td>
275
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
276
<td class="paramname"> <em>env</em>, </td>
279
<td class="paramkey"></td>
281
<td class="paramtype"><a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> * </td>
282
<td class="paramname"> <em>node</em></td><td> </td>
287
<td></td><td></td><td width="100%"></td>
294
Convert an XPath result to a boolean. If the result is a boolean the value of it is returned. If the result is a number, AXIS2_TRUE is returned if the value is not equal to 0 and AXIS2_FALSE otherwise. Otherwise AXIS2_TRUE is returned if the result is not NULL and AXIS2_FALSE otherwise.<p>
295
<dl compact><dt><b>Parameters:</b></dt><dd>
296
<table border="0" cellspacing="2" cellpadding="0">
297
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
298
<tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>A pointer to the XPath result </td></tr>
301
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The boolean value. </dd></dl>
305
<a class="anchor" name="ge9336d53cde0e884f5fb213b9df02674"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_cast_node_to_number" ref="ge9336d53cde0e884f5fb213b9df02674" args="(const axutil_env_t *env, axiom_xpath_result_node_t *node)" -->
306
<div class="memitem">
307
<div class="memproto">
308
<table class="memname">
310
<td class="memname">AXIS2_EXTERN double axiom_xpath_cast_node_to_number </td>
312
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
313
<td class="paramname"> <em>env</em>, </td>
316
<td class="paramkey"></td>
318
<td class="paramtype"><a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> * </td>
319
<td class="paramname"> <em>node</em></td><td> </td>
324
<td></td><td></td><td width="100%"></td>
331
Convert an XPath result to a number. If the result is a boolean, 1 is returned if it's true and 0 otherwise. If the result is a number the value of it is returned. Otherwise AXIS2_TRUE is returned if the result is not NULL and AXIS2_FALSE otherwise.<p>
332
<dl compact><dt><b>Parameters:</b></dt><dd>
333
<table border="0" cellspacing="2" cellpadding="0">
334
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
335
<tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>A pointer to the XPath result </td></tr>
338
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The numerical value. </dd></dl>
342
<a class="anchor" name="g326af499dbf89b48595f9f8464472488"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_cast_node_to_string" ref="g326af499dbf89b48595f9f8464472488" args="(const axutil_env_t *env, axiom_xpath_result_node_t *node)" -->
343
<div class="memitem">
344
<div class="memproto">
345
<table class="memname">
347
<td class="memname">AXIS2_EXTERN axis2_char_t* axiom_xpath_cast_node_to_string </td>
349
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
350
<td class="paramname"> <em>env</em>, </td>
353
<td class="paramkey"></td>
355
<td class="paramtype"><a class="el" href="structaxiom__xpath__result__node.html">axiom_xpath_result_node_t</a> * </td>
356
<td class="paramname"> <em>node</em></td><td> </td>
361
<td></td><td></td><td width="100%"></td>
368
Convert an XPath result to text. If the result is a boolean, "true" is returned if it's true and "false" otherwise. If the result is a number the text representation of it is returned. If the result is a text the value of it is returned. If the result is an axiom node, the text value of it is returned If the result is an axiom attribue, the text value of it is returned<p>
369
<dl compact><dt><b>Parameters:</b></dt><dd>
370
<table border="0" cellspacing="2" cellpadding="0">
371
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
372
<tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>A pointer to the XPath result </td></tr>
375
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The text value. </dd></dl>
379
<a class="anchor" name="g3c28eba21a5183ab268021129d9cad12"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_clear_namespaces" ref="g3c28eba21a5183ab268021129d9cad12" args="(axiom_xpath_context_t *context)" -->
380
<div class="memitem">
381
<div class="memproto">
382
<table class="memname">
384
<td class="memname">AXIS2_EXTERN void axiom_xpath_clear_namespaces </td>
386
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
387
<td class="paramname"> <em>context</em> </td>
388
<td> ) </td>
389
<td width="100%"></td>
396
Clears all registered XPath namespaces<p>
397
<dl compact><dt><b>Parameters:</b></dt><dd>
398
<table border="0" cellspacing="2" cellpadding="0">
399
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath Context, must not be null </td></tr>
405
<a class="anchor" name="g34b8a60579233870162ebf5d416dc3ac"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_compile_expression" ref="g34b8a60579233870162ebf5d416dc3ac" args="(const axutil_env_t *env, const axis2_char_t *xpath_expr)" -->
406
<div class="memitem">
407
<div class="memproto">
408
<table class="memname">
410
<td class="memname">AXIS2_EXTERN <a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a>* axiom_xpath_compile_expression </td>
412
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
413
<td class="paramname"> <em>env</em>, </td>
416
<td class="paramkey"></td>
418
<td class="paramtype">const axis2_char_t * </td>
419
<td class="paramname"> <em>xpath_expr</em></td><td> </td>
424
<td></td><td></td><td width="100%"></td>
431
Compile an XPath expression<p>
432
<dl compact><dt><b>Parameters:</b></dt><dd>
433
<table border="0" cellspacing="2" cellpadding="0">
434
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
435
<tr><td valign="top"></td><td valign="top"><em>xpath_expr</em> </td><td>A pointer to the XPath expression </td></tr>
438
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The parsed XPath expression. Returns NULL if an error occured while parsing. </dd></dl>
442
<a class="anchor" name="g9835edaade1499c3f3f22a1028e841ff"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_context_create" ref="g9835edaade1499c3f3f22a1028e841ff" args="(const axutil_env_t *env, axiom_node_t *root_node)" -->
443
<div class="memitem">
444
<div class="memproto">
445
<table class="memname">
447
<td class="memname">AXIS2_EXTERN <a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a>* axiom_xpath_context_create </td>
449
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
450
<td class="paramname"> <em>env</em>, </td>
453
<td class="paramkey"></td>
455
<td class="paramtype">axiom_node_t * </td>
456
<td class="paramname"> <em>root_node</em></td><td> </td>
461
<td></td><td></td><td width="100%"></td>
468
Create an empty XPath context<p>
469
<dl compact><dt><b>Parameters:</b></dt><dd>
470
<table border="0" cellspacing="2" cellpadding="0">
471
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
472
<tr><td valign="top"></td><td valign="top"><em>root_node</em> </td><td>A pointer to the root of the tree </td></tr>
475
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The initialized XPath context. </dd></dl>
479
<a class="anchor" name="g2012e8e16e51b0d9aec32d85ae12a61a"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_evaluate" ref="g2012e8e16e51b0d9aec32d85ae12a61a" args="(axiom_xpath_context_t *context, axiom_xpath_expression_t *xpath_expr)" -->
480
<div class="memitem">
481
<div class="memproto">
482
<table class="memname">
484
<td class="memname">AXIS2_EXTERN <a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result_t</a>* axiom_xpath_evaluate </td>
486
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
487
<td class="paramname"> <em>context</em>, </td>
490
<td class="paramkey"></td>
492
<td class="paramtype"><a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> * </td>
493
<td class="paramname"> <em>xpath_expr</em></td><td> </td>
498
<td></td><td></td><td width="100%"></td>
505
Evaluate an parsed XPath expression. Different expressions could be evaluated on the same context, and same expression could be evaluated on multiple trees without recompiling.<p>
506
<dl compact><dt><b>Parameters:</b></dt><dd>
507
<table border="0" cellspacing="2" cellpadding="0">
508
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath context must not be null </td></tr>
509
<tr><td valign="top"></td><td valign="top"><em>xpath_expr</em> </td><td>XPath expression to be evaluated </td></tr>
512
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The set of results. </dd></dl>
516
<a class="anchor" name="g1cd43a5e6fb152d14a218f923418f8d6"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_evaluate_streaming" ref="g1cd43a5e6fb152d14a218f923418f8d6" args="(axiom_xpath_context_t *context, axiom_xpath_expression_t *xpath_expr)" -->
517
<div class="memitem">
518
<div class="memproto">
519
<table class="memname">
521
<td class="memname">AXIS2_EXTERN <a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result_t</a>* axiom_xpath_evaluate_streaming </td>
523
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
524
<td class="paramname"> <em>context</em>, </td>
527
<td class="paramkey"></td>
529
<td class="paramtype"><a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> * </td>
530
<td class="paramname"> <em>xpath_expr</em></td><td> </td>
535
<td></td><td></td><td width="100%"></td>
542
Evaluates an XPath expression on streaming XML. Not all expressions can be evaluated on streaming XML. If the expression cannot be evaluated on streaming XML NULL will be returned.<p>
543
<dl compact><dt><b>Parameters:</b></dt><dd>
544
<table border="0" cellspacing="2" cellpadding="0">
545
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath Context, must not be null </td></tr>
546
<tr><td valign="top"></td><td valign="top"><em>xpath_expr</em> </td><td>XPath expression to be evaluated </td></tr>
552
<a class="anchor" name="g9c605179eff1ce688aeed2bb3a5a615f"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_free_context" ref="g9c605179eff1ce688aeed2bb3a5a615f" args="(const axutil_env_t *env, axiom_xpath_context_t *context)" -->
553
<div class="memitem">
554
<div class="memproto">
555
<table class="memname">
557
<td class="memname">AXIS2_EXTERN void axiom_xpath_free_context </td>
559
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
560
<td class="paramname"> <em>env</em>, </td>
563
<td class="paramkey"></td>
565
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
566
<td class="paramname"> <em>context</em></td><td> </td>
571
<td></td><td></td><td width="100%"></td>
578
Free XPath context<p>
579
<dl compact><dt><b>Parameters:</b></dt><dd>
580
<table border="0" cellspacing="2" cellpadding="0">
581
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
582
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath context must not be null </td></tr>
588
<a class="anchor" name="g5c75692634a5b8c50aa215838164873c"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_free_expression" ref="g5c75692634a5b8c50aa215838164873c" args="(const axutil_env_t *env, axiom_xpath_expression_t *xpath_expr)" -->
589
<div class="memitem">
590
<div class="memproto">
591
<table class="memname">
593
<td class="memname">AXIS2_EXTERN void axiom_xpath_free_expression </td>
595
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
596
<td class="paramname"> <em>env</em>, </td>
599
<td class="paramkey"></td>
601
<td class="paramtype"><a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> * </td>
602
<td class="paramname"> <em>xpath_expr</em></td><td> </td>
607
<td></td><td></td><td width="100%"></td>
614
Free XPath expression<p>
615
<dl compact><dt><b>Parameters:</b></dt><dd>
616
<table border="0" cellspacing="2" cellpadding="0">
617
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
618
<tr><td valign="top"></td><td valign="top"><em>xpath_expr</em> </td><td>XPath expression must not be null </td></tr>
624
<a class="anchor" name="gbce6df5e417ac892e3c472a9e8d9b159"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_free_result" ref="gbce6df5e417ac892e3c472a9e8d9b159" args="(const axutil_env_t *env, axiom_xpath_result_t *result)" -->
625
<div class="memitem">
626
<div class="memproto">
627
<table class="memname">
629
<td class="memname">AXIS2_EXTERN void axiom_xpath_free_result </td>
631
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
632
<td class="paramname"> <em>env</em>, </td>
635
<td class="paramkey"></td>
637
<td class="paramtype"><a class="el" href="structaxiom__xpath__result.html">axiom_xpath_result_t</a> * </td>
638
<td class="paramname"> <em>result</em></td><td> </td>
643
<td></td><td></td><td width="100%"></td>
650
Free XPath result set<p>
651
<dl compact><dt><b>Parameters:</b></dt><dd>
652
<table border="0" cellspacing="2" cellpadding="0">
653
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Environment must not be null </td></tr>
654
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>XPath result set must not be null </td></tr>
660
<a class="anchor" name="g0cff83ae01a93dfd36978407b9895399"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_get_function" ref="g0cff83ae01a93dfd36978407b9895399" args="(axiom_xpath_context_t *context, axis2_char_t *name)" -->
661
<div class="memitem">
662
<div class="memproto">
663
<table class="memname">
665
<td class="memname">AXIS2_EXTERN axiom_xpath_function_t axiom_xpath_get_function </td>
667
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
668
<td class="paramname"> <em>context</em>, </td>
671
<td class="paramkey"></td>
673
<td class="paramtype">axis2_char_t * </td>
674
<td class="paramname"> <em>name</em></td><td> </td>
679
<td></td><td></td><td width="100%"></td>
686
Retrive a pointer to a registered funciton by the function name. If there is no function registered by the given name, NULL will be returned.<p>
687
<dl compact><dt><b>Parameters:</b></dt><dd>
688
<table border="0" cellspacing="2" cellpadding="0">
689
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath Context, must not be null </td></tr>
690
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the function, must not be null </td></tr>
693
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The corresponding function. </dd></dl>
697
<a class="anchor" name="g81ba6657a1992f1b45a0930f7a413b68"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_get_namespace" ref="g81ba6657a1992f1b45a0930f7a413b68" args="(axiom_xpath_context_t *context, axis2_char_t *prefix)" -->
698
<div class="memitem">
699
<div class="memproto">
700
<table class="memname">
702
<td class="memname">AXIS2_EXTERN axiom_namespace_t* axiom_xpath_get_namespace </td>
704
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
705
<td class="paramname"> <em>context</em>, </td>
708
<td class="paramkey"></td>
710
<td class="paramtype">axis2_char_t * </td>
711
<td class="paramname"> <em>prefix</em></td><td> </td>
716
<td></td><td></td><td width="100%"></td>
723
Get a registered namespace by the prefix. If there is no namespace registered by the given prefix NULL will be returned<p>
724
<dl compact><dt><b>Parameters:</b></dt><dd>
725
<table border="0" cellspacing="2" cellpadding="0">
726
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath Context, must not be null </td></tr>
727
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>Prefix of the namespace, must not be null </td></tr>
730
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The namespace corresponding to the prefix. </dd></dl>
734
<a class="anchor" name="gaa194fb637ad142a32510933243ddda5"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_register_default_functions_set" ref="gaa194fb637ad142a32510933243ddda5" args="(axiom_xpath_context_t *context)" -->
735
<div class="memitem">
736
<div class="memproto">
737
<table class="memname">
739
<td class="memname">AXIS2_EXTERN void axiom_xpath_register_default_functions_set </td>
741
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
742
<td class="paramname"> <em>context</em> </td>
743
<td> ) </td>
744
<td width="100%"></td>
751
Setup the XPath core function library<p>
752
<dl compact><dt><b>Parameters:</b></dt><dd>
753
<table border="0" cellspacing="2" cellpadding="0">
754
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath Context, must not be null </td></tr>
760
<a class="anchor" name="gb6cc87a2fa3c5adf9d7844d21e2f747b"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_register_function" ref="gb6cc87a2fa3c5adf9d7844d21e2f747b" args="(axiom_xpath_context_t *context, axis2_char_t *name, axiom_xpath_function_t func)" -->
761
<div class="memitem">
762
<div class="memproto">
763
<table class="memname">
765
<td class="memname">AXIS2_EXTERN void axiom_xpath_register_function </td>
767
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
768
<td class="paramname"> <em>context</em>, </td>
771
<td class="paramkey"></td>
773
<td class="paramtype">axis2_char_t * </td>
774
<td class="paramname"> <em>name</em>, </td>
777
<td class="paramkey"></td>
779
<td class="paramtype">axiom_xpath_function_t </td>
780
<td class="paramname"> <em>func</em></td><td> </td>
785
<td></td><td></td><td width="100%"></td>
792
Registers a custom XPath function <a href="http://www.w3.org/TR/xpath#corelib">http://www.w3.org/TR/xpath#corelib</a><p>
793
<dl compact><dt><b>Parameters:</b></dt><dd>
794
<table border="0" cellspacing="2" cellpadding="0">
795
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath Context, must not be null </td></tr>
796
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of the function, must not be null </td></tr>
797
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>Pointer to the function, must not be null </td></tr>
803
<a class="anchor" name="g521831b95af07a1d758870955e21ec46"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_register_namespace" ref="g521831b95af07a1d758870955e21ec46" args="(axiom_xpath_context_t *context, axiom_namespace_t *ns)" -->
804
<div class="memitem">
805
<div class="memproto">
806
<table class="memname">
808
<td class="memname">AXIS2_EXTERN void axiom_xpath_register_namespace </td>
810
<td class="paramtype"><a class="el" href="structaxiom__xpath__context.html">axiom_xpath_context_t</a> * </td>
811
<td class="paramname"> <em>context</em>, </td>
814
<td class="paramkey"></td>
816
<td class="paramtype">axiom_namespace_t * </td>
817
<td class="paramname"> <em>ns</em></td><td> </td>
822
<td></td><td></td><td width="100%"></td>
829
Registers a XPath namespace<p>
830
<dl compact><dt><b>Parameters:</b></dt><dd>
831
<table border="0" cellspacing="2" cellpadding="0">
832
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>XPath Context, must not be null </td></tr>
833
<tr><td valign="top"></td><td valign="top"><em>ns</em> </td><td>AXIOM namespace, must not be null </td></tr>
839
<a class="anchor" name="g83c7017c40dd0977276b77d97cbff6a5"></a><!-- doxytag: member="axiom_xpath.h::axiom_xpath_streaming_check" ref="g83c7017c40dd0977276b77d97cbff6a5" args="(const axutil_env_t *env, axiom_xpath_expression_t *expr)" -->
840
<div class="memitem">
841
<div class="memproto">
842
<table class="memname">
844
<td class="memname">AXIS2_EXTERN axis2_bool_t axiom_xpath_streaming_check </td>
846
<td class="paramtype">const <a class="el" href="structaxutil__env.html">axutil_env_t</a> * </td>
847
<td class="paramname"> <em>env</em>, </td>
850
<td class="paramkey"></td>
852
<td class="paramtype"><a class="el" href="structaxiom__xpath__expression.html">axiom_xpath_expression_t</a> * </td>
853
<td class="paramname"> <em>expr</em></td><td> </td>
858
<td></td><td></td><td width="100%"></td>
865
Checks whether the given expression can be evaluated on streaming XML. If it is possible AXIS2_TRUE will be retuned; AXIS2_FALSE otherwise.<p>
866
<dl compact><dt><b>Parameters:</b></dt><dd>
867
<table border="0" cellspacing="2" cellpadding="0">
868
<tr><td valign="top"></td><td valign="top"><em>env</em> </td><td>Axis2 environment, must not be null </td></tr>
869
<tr><td valign="top"></td><td valign="top"><em>expr</em> </td><td>Complied XPath expression, must not be null </td></tr>
872
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A boolean indicating whether the expression can be evaluated on streaming XML. </dd></dl>
876
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Apr 17 11:49:44 2009 for Axis2/C by
877
<a href="http://www.doxygen.org/index.html">
878
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
added
removed
docs/api/html/group__axiom__xpath__api.html
