File: xpointer_8h.html

package info (click to toggle)
libxml2 2.15.2%2Bdfsg-0.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 31,036 kB
  • sloc: xml: 305,167; ansic: 138,598; python: 6,692; javascript: 5,897; sh: 4,736; makefile: 1,308
file content (194 lines) | stat: -rw-r--r-- 9,296 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libxml2: xpointer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="libxml2.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">libxml2
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">xpointer.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>XPointer framework and schemes.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad266411e3b0eb3176b33ea279b67ed40" id="r_ad266411e3b0eb3176b33ea279b67ed40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xpath_8h.html#a61100c9bec26c0de1d0329962c85c091">xmlXPathContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpointer_8h.html#ad266411e3b0eb3176b33ea279b67ed40">xmlXPtrNewContext</a> (<a class="el" href="tree_8h.html#ae94acff8b6413934705e29389bcddc17">xmlDoc</a> *doc, <a class="el" href="tree_8h.html#ac8c054adbdabc014ab4584dfb1ce841e">xmlNode</a> *here, <a class="el" href="tree_8h.html#ac8c054adbdabc014ab4584dfb1ce841e">xmlNode</a> *origin)</td></tr>
<tr class="memdesc:ad266411e3b0eb3176b33ea279b67ed40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new XPointer context.  <br /></td></tr>
<tr class="separator:ad266411e3b0eb3176b33ea279b67ed40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20078f45c75ddf4a44d8ff835439e980" id="r_a20078f45c75ddf4a44d8ff835439e980"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xpath_8h.html#a60f7ba568242d9876ac3b78d1c9b2893">xmlXPathObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpointer_8h.html#a20078f45c75ddf4a44d8ff835439e980">xmlXPtrEval</a> (const <a class="el" href="xmlstring_8h.html#afb1489b546f7800463867523ffaee1d3">xmlChar</a> *str, <a class="el" href="xpath_8h.html#a61100c9bec26c0de1d0329962c85c091">xmlXPathContext</a> *ctx)</td></tr>
<tr class="memdesc:a20078f45c75ddf4a44d8ff835439e980"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate an XPointer expression.  <br /></td></tr>
<tr class="separator:a20078f45c75ddf4a44d8ff835439e980"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>XPointer framework and schemes. </p>
<p>API to evaluate XPointer expressions. The following schemes are supported:</p>
<ul>
<li>element()</li>
<li>xmlns()</li>
<li>xpath1()</li>
</ul>
<p>xpointer() is an alias for the xpath1() scheme. The point and range extensions are not supported.</p>
<dl class="section copyright"><dt>Copyright</dt><dd>See Copyright for the status of this software.</dd></dl>
<dl class="section author"><dt>Author</dt><dd>Daniel Veillard </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a20078f45c75ddf4a44d8ff835439e980" name="a20078f45c75ddf4a44d8ff835439e980"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20078f45c75ddf4a44d8ff835439e980">&#9670;&#160;</a></span>xmlXPtrEval()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="xpath_8h.html#a60f7ba568242d9876ac3b78d1c9b2893">xmlXPathObject</a> * xmlXPtrEval </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="xmlstring_8h.html#afb1489b546f7800463867523ffaee1d3">xmlChar</a> *&#160;</td>
          <td class="paramname"><em>str</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xpath_8h.html#a61100c9bec26c0de1d0329962c85c091">xmlXPathContext</a> *&#160;</td>
          <td class="paramname"><em>ctx</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Evaluate an XPointer expression. </p>
<p>This function can only return nodesets. The caller has to free the object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">str</td><td>an XPointer expression </td></tr>
    <tr><td class="paramname">ctx</td><td>an XPath context </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the xmlXPathObject resulting from the evaluation or NULL in case of error. </dd></dl>

</div>
</div>
<a id="ad266411e3b0eb3176b33ea279b67ed40" name="ad266411e3b0eb3176b33ea279b67ed40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad266411e3b0eb3176b33ea279b67ed40">&#9670;&#160;</a></span>xmlXPtrNewContext()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="xpath_8h.html#a61100c9bec26c0de1d0329962c85c091">xmlXPathContext</a> * xmlXPtrNewContext </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="tree_8h.html#ae94acff8b6413934705e29389bcddc17">xmlDoc</a> *&#160;</td>
          <td class="paramname"><em>doc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="tree_8h.html#ac8c054adbdabc014ab4584dfb1ce841e">xmlNode</a> *&#160;</td>
          <td class="paramname"><em>here</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="tree_8h.html#ac8c054adbdabc014ab4584dfb1ce841e">xmlNode</a> *&#160;</td>
          <td class="paramname"><em>origin</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a new XPointer context. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000434">Deprecated:</a></b></dt><dd>Same as xmlXPathNewContext.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">doc</td><td>the XML document </td></tr>
    <tr><td class="paramname">here</td><td>unused </td></tr>
    <tr><td class="paramname">origin</td><td>unused </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the xmlXPathContext just allocated. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>