diff options
Diffstat (limited to 'docs/api/xmlsec-nodeset.html')
| -rw-r--r-- | docs/api/xmlsec-nodeset.html | 1010 |
1 files changed, 461 insertions, 549 deletions
diff --git a/docs/api/xmlsec-nodeset.html b/docs/api/xmlsec-nodeset.html index 62358985..1029ae1f 100644 --- a/docs/api/xmlsec-nodeset.html +++ b/docs/api/xmlsec-nodeset.html @@ -1,798 +1,713 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> -<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> -<title>nodeset</title> -<meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79"> -<link rel="HOME" title="XML Security Library Reference Manual" href="index.html"> -<link rel="UP" title="XML Security Core Library API Reference." href="xmlsec-ref.html"> -<link rel="PREVIOUS" title="membuf" href="xmlsec-membuf.html"> -<link rel="NEXT" title="parser" href="xmlsec-parser.html"> -<style type="text/css">.synopsis, .classsynopsis { - background: #eeeeee; - border: solid 1px #aaaaaa; - padding: 0.5em; -} -.programlisting { - background: #eeeeff; - border: solid 1px #aaaaff; - padding: 0.5em; -} -.variablelist { - padding: 4px; - margin-left: 3em; -} -.navigation { - background: #ffeeee; - border: solid 1px #ffaaaa; - margin-top: 0.5em; - margin-bottom: 0.5em; -} -.navigation a { - color: #770000; -} -.navigation a:visited { - color: #550000; -} -.navigation .title { - font-size: 200%; -}</style> -<style type="text/css"> -table.CALSTABLE > tbody > tr:nth-child(1) > td:nth-child(1) { - width: 20em; -} -.synopsis, .classsynopsis { - background: #eeeeee; - border: solid 1px #aaaaaa; -} -.programlisting { - background: #eeeeee; - border: solid 1px #000000; -} -.navigation { - background: #eeeeee; - border: solid 1px #000000; -} -.navigation a { - color: initial; -} -.navigation a:visited { - color: initial; -} -</style> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>nodeset: XML Security Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="XML Security Library Reference Manual"> +<link rel="up" href="xmlsec-ref.html" title="XML Security Core Library API Reference."> +<link rel="prev" href="xmlsec-membuf.html" title="membuf"> +<link rel="next" href="xmlsec-parser.html" title="parser"> +<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> </head> -<body><table width="100%" valign="top"><tr valign="top"> -<td valign="top" align="left" width="210"> -<img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p> -<ul> -<li><a href="../index.html">Home</a></li> -<li><a href="../download.html">Download</a></li> -<li><a href="../news.html">News</a></li> -<li><a href="../documentation.html">Documentation</a></li> -<ul> -<li><a href="../faq.html">FAQ</a></li> -<li><a href="../api/xmlsec-notes.html">Tutorial</a></li> -<li><a href="../api/xmlsec-reference.html">API reference</a></li> -<li><a href="../api/xmlsec-examples.html">Examples</a></li> -</ul> -<li><a href="../xmldsig.html">XML Digital Signature</a></li> -<ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul> -<li><a href="../xmlenc.html">XML Encryption</a></li> -<li><a href="../c14n.html">XML Canonicalization</a></li> -<li><a href="../bugs.html">Reporting Bugs</a></li> -<li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li> -<li><a href="../related.html">Related</a></li> -<li><a href="../authors.html">Authors</a></li> -</ul> -<table width="100%"> -<tr> -<td width="15"></td> -<td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td> -</tr> -<tr> -<td width="15"></td> -<td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td> -</tr> -<tr> -<td width="15"></td> -<td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td> -</tr> -<!--Links - start--><!--Links - end--> -</table> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#xmlsec-nodeset.description" class="shortcut">Description</a></span> </td> -<td valign="top"><table width="100%" valign="top"><tr><td valign="top" align="left" id="xmlsecContent"> -<table width="100%" class="navigation" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td><a accesskey="p" href="xmlsec-membuf.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="xmlsec-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<th width="100%" align="center">XML Security Library Reference Manual</th> +<td><a accesskey="u" href="xmlsec-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="xmlsec-membuf.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="xmlsec-parser.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> -<h1> -<a name="XMLSEC-NODESET"></a>nodeset</h1> -<div class="REFNAMEDIV"> -<a name="AEN16075"></a><h2>Name</h2>nodeset -- Nodeset object implementation.</div> -<div class="REFSECT1"> -<a name="XMLSEC-NODESET.FUNCTIONS"></a><h2>Functions</h2> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16080"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refentry"> +<a name="xmlsec-nodeset"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="xmlsec-nodeset.top_of_page"></a>nodeset</span></h2> +<p>nodeset — XML nodes set functions</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="xmlsec-nodeset.stability-level"></a><h2>Stability Level</h2> +<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated +</div> +<div class="refsect1"> +<a name="xmlsec-nodeset.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> +</colgroup> <tbody> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<span class="c_punctuation"><span class="PHRASE">(</span></span><a href="xmlsec-nodeset.html#XMLSECNODESETWALKCALLBACK">*xmlSecNodeSetWalkCallback</a><span class="c_punctuation"><span class="PHRASE">)</span></span> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetWalkCallback" title="xmlSecNodeSetWalkCallback ()">*xmlSecNodeSetWalkCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="RETURNVALUE">xmlSecNodeSetPtr</span></a></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETCREATE">xmlSecNodeSetCreate</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="returnvalue">xmlSecNodeSetPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetCreate" title="xmlSecNodeSetCreate ()">xmlSecNodeSetCreate</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">void</span></font></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETDESTROY">xmlSecNodeSetDestroy</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">void</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetDestroy" title="xmlSecNodeSetDestroy ()">xmlSecNodeSetDestroy</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">void</span></font></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETDOCDESTROY">xmlSecNodeSetDocDestroy</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">void</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetDocDestroy" title="xmlSecNodeSetDocDestroy ()">xmlSecNodeSetDocDestroy</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETCONTAINS">xmlSecNodeSetContains</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetContains" title="xmlSecNodeSetContains ()">xmlSecNodeSetContains</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="RETURNVALUE">xmlSecNodeSetPtr</span></a></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETADD">xmlSecNodeSetAdd</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="returnvalue">xmlSecNodeSetPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetAdd" title="xmlSecNodeSetAdd ()">xmlSecNodeSetAdd</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="RETURNVALUE">xmlSecNodeSetPtr</span></a></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETADDLIST">xmlSecNodeSetAddList</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="returnvalue">xmlSecNodeSetPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetAddList" title="xmlSecNodeSetAddList ()">xmlSecNodeSetAddList</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="RETURNVALUE">xmlSecNodeSetPtr</span></a></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETGETCHILDREN">xmlSecNodeSetGetChildren</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="returnvalue">xmlSecNodeSetPtr</span></a> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetGetChildren" title="xmlSecNodeSetGetChildren ()">xmlSecNodeSetGetChildren</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETWALK">xmlSecNodeSetWalk</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetWalk" title="xmlSecNodeSetWalk ()">xmlSecNodeSetWalk</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">int</span></font></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETDUMPTEXTNODES">xmlSecNodeSetDumpTextNodes</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">int</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetDumpTextNodes" title="xmlSecNodeSetDumpTextNodes ()">xmlSecNodeSetDumpTextNodes</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><font><span class="RETURNVALUE">void</span></font></td> -<td> -<a href="xmlsec-nodeset.html#XMLSECNODESETDEBUGDUMP">xmlSecNodeSetDebugDump</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +<td class="function_type"> +<font><span class="returnvalue">void</span></font> +</td> +<td class="function_name"> +<a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetDebugDump" title="xmlSecNodeSetDebugDump ()">xmlSecNodeSetDebugDump</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT1"> -<a name="XMLSEC-NODESET.OTHER"></a><h2>Types and Values</h2> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16164"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect1"> +<a name="xmlsec-nodeset.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> +</colgroup> <tbody> <tr> -<td>enum</td> -<td><a href="xmlsec-nodeset.html#XMLSECNODESETTYPE">xmlSecNodeSetType</a></td> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetType" title="enum xmlSecNodeSetType">xmlSecNodeSetType</a></td> </tr> <tr> -<td>enum</td> -<td><a href="xmlsec-nodeset.html#XMLSECNODESETOP">xmlSecNodeSetOp</a></td> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetOp" title="enum xmlSecNodeSetOp">xmlSecNodeSetOp</a></td> </tr> <tr> -<td>struct</td> -<td><a href="xmlsec-nodeset.html#XMLSECNODESET">xmlSecNodeSet</a></td> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet">xmlSecNodeSet</a></td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> +<div class="refsect1"> +<a name="xmlsec-nodeset.description"></a><h2>Description</h2> +<p></p> </div> -<div class="REFSECT1"> -<a name="XMLSEC-NODESET.DESCRIPTION"></a><h2>Description</h2> -<p>Nodeset object implementation.</p> -</div> -<div class="REFSECT1"> -<a name="XMLSEC-NODESET.FUNCTIONS_DETAILS"></a><h2>Functions</h2> -<div class="REFSECT2"> -<a name="XMLSECNODESETWALKCALLBACK"></a><h3>xmlSecNodeSetWalkCallback ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -<span class="c_punctuation"><span class="PHRASE">(</span></span>*xmlSecNodeSetWalkCallback<span class="c_punctuation"><span class="PHRASE">)</span></span> (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>, - <code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> cur</code>, - <code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> parent</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *data</code>);</pre> +<div class="refsect1"> +<a name="xmlsec-nodeset.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="xmlSecNodeSetWalkCallback"></a><h3>xmlSecNodeSetWalkCallback ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +<span class="c_punctuation">(</span>*xmlSecNodeSetWalkCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>, + <em class="parameter"><code><font><span class="type">xmlNodePtr</span></font> cur</code></em>, + <em class="parameter"><code><font><span class="type">xmlNodePtr</span></font> parent</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *data</code></em>);</pre> <p>The callback function called once per each node in the nodes set.</p> -<div class="REFSECT3"> -<a name="AEN16206"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16208"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetWalkCallback.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>nset</p></td> -<td><p>the pointer to <a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSet</span></a> structure.</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to <a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSet</span></a> structure.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>cur</p></td> -<td><p>the pointer current XML node.</p></td> -<td> </td> +<td class="parameter_name"><p>cur</p></td> +<td class="parameter_description"><p>the pointer current XML node.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>parent</p></td> -<td><p>the pointer to the <code class="PARAMETER">cur</code> +<td class="parameter_name"><p>parent</p></td> +<td class="parameter_description"><p>the pointer to the <em class="parameter"><code>cur</code></em> parent node.</p></td> -<td> </td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>data</p></td> -<td><p>the pointer to application specific data.</p></td> -<td> </td> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the pointer to application specific data.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN16238"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecNodeSetWalkCallback.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value if an error occurs an walk procedure should be interrupted.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETCREATE"></a><h3>xmlSecNodeSetCreate ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="RETURNVALUE">xmlSecNodeSetPtr</span></a> -xmlSecNodeSetCreate (<code class="PARAMETER"><font><span class="TYPE">xmlDocPtr</span></font> doc</code>, - <code class="PARAMETER"><font><span class="TYPE">xmlNodeSetPtr</span></font> nodes</code>, - <code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESETTYPE"><span class="TYPE">xmlSecNodeSetType</span></a> type</code>);</pre> +<div class="refsect2"> +<a name="xmlSecNodeSetCreate"></a><h3>xmlSecNodeSetCreate ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="returnvalue">xmlSecNodeSetPtr</span></a> +xmlSecNodeSetCreate (<em class="parameter"><code><font><span class="type">xmlDocPtr</span></font> doc</code></em>, + <em class="parameter"><code><font><span class="type">xmlNodeSetPtr</span></font> nodes</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetType" title="enum xmlSecNodeSetType"><span class="type">xmlSecNodeSetType</span></a> type</code></em>);</pre> <p>Creates new nodes set. Caller is responsible for freeing returned object -by calling <a href="xmlsec-nodeset.html#XMLSECNODESETDESTROY"><span class="TYPE">xmlSecNodeSetDestroy</span></a> function.</p> -<div class="REFSECT3"> -<a name="AEN16260"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16262"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +by calling <a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetDestroy" title="xmlSecNodeSetDestroy ()"><span class="type">xmlSecNodeSetDestroy</span></a> function.</p> +<div class="refsect3"> +<a name="xmlSecNodeSetCreate.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>doc</p></td> -<td><p>the pointer to parent XML document.</p></td> -<td> </td> +<td class="parameter_name"><p>doc</p></td> +<td class="parameter_description"><p>the pointer to parent XML document.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>nodes</p></td> -<td><p>the list of nodes.</p></td> -<td> </td> +<td class="parameter_name"><p>nodes</p></td> +<td class="parameter_description"><p>the list of nodes.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>type</p></td> -<td><p>the nodes set type.</p></td> -<td> </td> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>the nodes set type.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN16283"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecNodeSetCreate.returns"></a><h4>Returns</h4> <p> pointer to newly allocated node set or NULL if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETDESTROY"></a><h3>xmlSecNodeSetDestroy ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">void</span></font> -xmlSecNodeSetDestroy (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>);</pre> -<p>Destroys the nodes set created with <a href="xmlsec-nodeset.html#XMLSECNODESETCREATE"><span class="TYPE">xmlSecNodeSetCreate</span></a> function.</p> -<div class="REFSECT3"> -<a name="AEN16299"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16301"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect2"> +<a name="xmlSecNodeSetDestroy"></a><h3>xmlSecNodeSetDestroy ()</h3> +<pre class="programlisting"><font><span class="returnvalue">void</span></font> +xmlSecNodeSetDestroy (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>);</pre> +<p>Destroys the nodes set created with <a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetCreate" title="xmlSecNodeSetCreate ()"><span class="type">xmlSecNodeSetCreate</span></a> function.</p> +<div class="refsect3"> +<a name="xmlSecNodeSetDestroy.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody><tr> -<td><p>nset</p></td> -<td><p>the pointer to node set.</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to node set.</p></td> +<td class="parameter_annotations"> </td> </tr></tbody> -</table> -<p></p> -</div> +</table></div> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETDOCDESTROY"></a><h3>xmlSecNodeSetDocDestroy ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">void</span></font> -xmlSecNodeSetDocDestroy (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>);</pre> +<div class="refsect2"> +<a name="xmlSecNodeSetDocDestroy"></a><h3>xmlSecNodeSetDocDestroy ()</h3> +<pre class="programlisting"><font><span class="returnvalue">void</span></font> +xmlSecNodeSetDocDestroy (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>);</pre> <p>Instructs node set to destroy nodes parent doc when node set is destroyed.</p> -<div class="REFSECT3"> -<a name="AEN16321"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16323"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetDocDestroy.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody><tr> -<td><p>nset</p></td> -<td><p>the pointer to node set.</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to node set.</p></td> +<td class="parameter_annotations"> </td> </tr></tbody> -</table> -<p></p> -</div> +</table></div> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETCONTAINS"></a><h3>xmlSecNodeSetContains ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecNodeSetContains (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>, - <code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> node</code>, - <code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> parent</code>);</pre> -<p>Checks whether the <code class="PARAMETER">node</code> +<div class="refsect2"> +<a name="xmlSecNodeSetContains"></a><h3>xmlSecNodeSetContains ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecNodeSetContains (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>, + <em class="parameter"><code><font><span class="type">xmlNodePtr</span></font> node</code></em>, + <em class="parameter"><code><font><span class="type">xmlNodePtr</span></font> parent</code></em>);</pre> +<p>Checks whether the <em class="parameter"><code>node</code></em> is in the nodes set or not.</p> -<div class="REFSECT3"> -<a name="AEN16350"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16352"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetContains.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>nset</p></td> -<td><p>the pointer to node set.</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to node set.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>node</p></td> -<td><p>the pointer to XML node to check.</p></td> -<td> </td> +<td class="parameter_name"><p>node</p></td> +<td class="parameter_description"><p>the pointer to XML node to check.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>parent</p></td> -<td><p>the pointer to <code class="PARAMETER">node</code> +<td class="parameter_name"><p>parent</p></td> +<td class="parameter_description"><p>the pointer to <em class="parameter"><code>node</code></em> parent node.</p></td> -<td> </td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN16374"></a><h4>Returns</h4> -<p> 1 if the <code class="PARAMETER">node</code> -is in the nodes set <code class="PARAMETER">nset</code> +<div class="refsect3"> +<a name="xmlSecNodeSetContains.returns"></a><h4>Returns</h4> +<p> 1 if the <em class="parameter"><code>node</code></em> +is in the nodes set <em class="parameter"><code>nset</code></em> , 0 if it is not and a negative value if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETADD"></a><h3>xmlSecNodeSetAdd ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="RETURNVALUE">xmlSecNodeSetPtr</span></a> -xmlSecNodeSetAdd (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>, - <code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> newNSet</code>, - <code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESETOP"><span class="TYPE">xmlSecNodeSetOp</span></a> op</code>);</pre> -<p>Adds <code class="PARAMETER">newNSet</code> - to the <code class="PARAMETER">nset</code> - using operation <code class="PARAMETER">op</code> +<div class="refsect2"> +<a name="xmlSecNodeSetAdd"></a><h3>xmlSecNodeSetAdd ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="returnvalue">xmlSecNodeSetPtr</span></a> +xmlSecNodeSetAdd (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> newNSet</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetOp" title="enum xmlSecNodeSetOp"><span class="type">xmlSecNodeSetOp</span></a> op</code></em>);</pre> +<p>Adds <em class="parameter"><code>newNSet</code></em> + to the <em class="parameter"><code>nset</code></em> + using operation <em class="parameter"><code>op</code></em> .</p> -<div class="REFSECT3"> -<a name="AEN16399"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16401"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetAdd.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>nset</p></td> -<td><p>the pointer to currrent nodes set (or NULL).</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to current nodes set (or NULL).</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>newNSet</p></td> -<td><p>the pointer to new nodes set.</p></td> -<td> </td> +<td class="parameter_name"><p>newNSet</p></td> +<td class="parameter_description"><p>the pointer to new nodes set.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>op</p></td> -<td><p>the operation type.</p></td> -<td> </td> +<td class="parameter_name"><p>op</p></td> +<td class="parameter_description"><p>the operation type.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN16422"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecNodeSetAdd.returns"></a><h4>Returns</h4> <p> the pointer to combined nodes set or NULL if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETADDLIST"></a><h3>xmlSecNodeSetAddList ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="RETURNVALUE">xmlSecNodeSetPtr</span></a> -xmlSecNodeSetAddList (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>, - <code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> newNSet</code>, - <code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESETOP"><span class="TYPE">xmlSecNodeSetOp</span></a> op</code>);</pre> -<p>Adds <code class="PARAMETER">newNSet</code> - to the <code class="PARAMETER">nset</code> - as child using operation <code class="PARAMETER">op</code> +<div class="refsect2"> +<a name="xmlSecNodeSetAddList"></a><h3>xmlSecNodeSetAddList ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="returnvalue">xmlSecNodeSetPtr</span></a> +xmlSecNodeSetAddList (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> newNSet</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetOp" title="enum xmlSecNodeSetOp"><span class="type">xmlSecNodeSetOp</span></a> op</code></em>);</pre> +<p>Adds <em class="parameter"><code>newNSet</code></em> + to the <em class="parameter"><code>nset</code></em> + as child using operation <em class="parameter"><code>op</code></em> .</p> -<div class="REFSECT3"> -<a name="AEN16445"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16447"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetAddList.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>nset</p></td> -<td><p>the pointer to currrent nodes set (or NULL).</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to current nodes set (or NULL).</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>newNSet</p></td> -<td><p>the pointer to new nodes set.</p></td> -<td> </td> +<td class="parameter_name"><p>newNSet</p></td> +<td class="parameter_description"><p>the pointer to new nodes set.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>op</p></td> -<td><p>the operation type.</p></td> -<td> </td> +<td class="parameter_name"><p>op</p></td> +<td class="parameter_description"><p>the operation type.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN16468"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecNodeSetAddList.returns"></a><h4>Returns</h4> <p> the pointer to combined nodes set or NULL if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETGETCHILDREN"></a><h3>xmlSecNodeSetGetChildren ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="RETURNVALUE">xmlSecNodeSetPtr</span></a> -xmlSecNodeSetGetChildren (<code class="PARAMETER"><font><span class="TYPE">xmlDocPtr</span></font> doc</code>, - <code class="PARAMETER">const <font><span class="TYPE">xmlNodePtr</span></font> parent</code>, - <code class="PARAMETER"><font><span class="TYPE">int</span></font> withComments</code>, - <code class="PARAMETER"><font><span class="TYPE">int</span></font> invert</code>);</pre> +<div class="refsect2"> +<a name="xmlSecNodeSetGetChildren"></a><h3>xmlSecNodeSetGetChildren ()</h3> +<pre class="programlisting"><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="returnvalue">xmlSecNodeSetPtr</span></a> +xmlSecNodeSetGetChildren (<em class="parameter"><code><font><span class="type">xmlDocPtr</span></font> doc</code></em>, + <em class="parameter"><code>const <font><span class="type">xmlNodePtr</span></font> parent</code></em>, + <em class="parameter"><code><font><span class="type">int</span></font> withComments</code></em>, + <em class="parameter"><code><font><span class="type">int</span></font> invert</code></em>);</pre> <p>Creates a new nodes set that contains:</p> -<p></p> -<ul> -<li><p>if <code class="PARAMETER">withComments</code> - is not 0 and <code class="PARAMETER">invert</code> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p>if <em class="parameter"><code>withComments</code></em> + is not 0 and <em class="parameter"><code>invert</code></em> is 0: -all nodes in the <code class="PARAMETER">parent</code> +all nodes in the <em class="parameter"><code>parent</code></em> subtree;</p></li> -<li><p>if <code class="PARAMETER">withComments</code> - is 0 and <code class="PARAMETER">invert</code> +<li class="listitem"><p>if <em class="parameter"><code>withComments</code></em> + is 0 and <em class="parameter"><code>invert</code></em> is 0: -all nodes in the <code class="PARAMETER">parent</code> +all nodes in the <em class="parameter"><code>parent</code></em> subtree except comment nodes;</p></li> -<li><p>if <code class="PARAMETER">withComments</code> - is not 0 and <code class="PARAMETER">invert</code> +<li class="listitem"><p>if <em class="parameter"><code>withComments</code></em> + is not 0 and <em class="parameter"><code>invert</code></em> not is 0: -all nodes in the <code class="PARAMETER">doc</code> - except nodes in the <code class="PARAMETER">parent</code> +all nodes in the <em class="parameter"><code>doc</code></em> + except nodes in the <em class="parameter"><code>parent</code></em> subtree;</p></li> -<li><p>if <code class="PARAMETER">withComments</code> - is 0 and <code class="PARAMETER">invert</code> +<li class="listitem"><p>if <em class="parameter"><code>withComments</code></em> + is 0 and <em class="parameter"><code>invert</code></em> is 0: -all nodes in the <code class="PARAMETER">doc</code> - except nodes in the <code class="PARAMETER">parent</code> +all nodes in the <em class="parameter"><code>doc</code></em> + except nodes in the <em class="parameter"><code>parent</code></em> subtree and comment nodes.</p></li> -</ul> -<div class="REFSECT3"> -<a name="AEN16514"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16516"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +</ul></div> +<div class="refsect3"> +<a name="xmlSecNodeSetGetChildren.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>doc</p></td> -<td><p>the pointer to an XML document.</p></td> -<td> </td> +<td class="parameter_name"><p>doc</p></td> +<td class="parameter_description"><p>the pointer to an XML document.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>parent</p></td> -<td><p>the pointer to parent XML node or NULL if we want to include all document nodes.</p></td> -<td> </td> +<td class="parameter_name"><p>parent</p></td> +<td class="parameter_description"><p>the pointer to parent XML node or NULL if we want to include all document nodes.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>withComments</p></td> -<td><p>the flag include comments or not.</p></td> -<td> </td> +<td class="parameter_name"><p>withComments</p></td> +<td class="parameter_description"><p>the flag include comments or not.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>invert</p></td> -<td><p>the "invert" flag.</p></td> -<td> </td> +<td class="parameter_name"><p>invert</p></td> +<td class="parameter_description"><p>the "invert" flag.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN16543"></a><h4>Returns</h4> -<p> pointer to the newly created <a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSet</span></a> structure +<div class="refsect3"> +<a name="xmlSecNodeSetGetChildren.returns"></a><h4>Returns</h4> +<p> pointer to the newly created <a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSet</span></a> structure or NULL if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETWALK"></a><h3>xmlSecNodeSetWalk ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecNodeSetWalk (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>, - <code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESETWALKCALLBACK"><span class="TYPE">xmlSecNodeSetWalkCallback</span></a> walkFunc</code>, - <code class="PARAMETER"><font><span class="TYPE">void</span></font> *data</code>);</pre> -<p>Calls the function <code class="PARAMETER">walkFunc</code> - once per each node in the nodes set <code class="PARAMETER">nset</code> +<div class="refsect2"> +<a name="xmlSecNodeSetWalk"></a><h3>xmlSecNodeSetWalk ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecNodeSetWalk (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>, + <em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetWalkCallback" title="xmlSecNodeSetWalkCallback ()"><span class="type">xmlSecNodeSetWalkCallback</span></a> walkFunc</code></em>, + <em class="parameter"><code><font><span class="type">void</span></font> *data</code></em>);</pre> +<p>Calls the function <em class="parameter"><code>walkFunc</code></em> + once per each node in the nodes set <em class="parameter"><code>nset</code></em> . -If the <code class="PARAMETER">walkFunc</code> +If the <em class="parameter"><code>walkFunc</code></em> returns a negative value, then the walk procedure is interrupted.</p> -<div class="REFSECT3"> -<a name="AEN16568"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16570"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetWalk.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>nset</p></td> -<td><p>the pointer to node set.</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to node set.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>walkFunc</p></td> -<td><p>the callback functions.</p></td> -<td> </td> +<td class="parameter_name"><p>walkFunc</p></td> +<td class="parameter_description"><p>the callback functions.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>data</p></td> -<td><p>the application specific data passed to the <code class="PARAMETER">walkFunc</code> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>the application specific data passed to the <em class="parameter"><code>walkFunc</code></em> .</p></td> -<td> </td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> -</div> -<div class="REFSECT3"> -<a name="AEN16592"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecNodeSetWalk.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value if an error occurs.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETDUMPTEXTNODES"></a><h3>xmlSecNodeSetDumpTextNodes ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> -xmlSecNodeSetDumpTextNodes (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>, - <code class="PARAMETER"><font><span class="TYPE">xmlOutputBufferPtr</span></font> out</code>);</pre> -<p>Dumps content of all the text nodes from <code class="PARAMETER">nset</code> - to <code class="PARAMETER">out</code> +<div class="refsect2"> +<a name="xmlSecNodeSetDumpTextNodes"></a><h3>xmlSecNodeSetDumpTextNodes ()</h3> +<pre class="programlisting"><font><span class="returnvalue">int</span></font> +xmlSecNodeSetDumpTextNodes (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>, + <em class="parameter"><code><font><span class="type">xmlOutputBufferPtr</span></font> out</code></em>);</pre> +<p>Dumps content of all the text nodes from <em class="parameter"><code>nset</code></em> + to <em class="parameter"><code>out</code></em> .</p> -<div class="REFSECT3"> -<a name="AEN16611"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16613"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetDumpTextNodes.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>nset</p></td> -<td><p>the pointer to node set.</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to node set.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>out</p></td> -<td><p>the output buffer.</p></td> -<td> </td> +<td class="parameter_name"><p>out</p></td> +<td class="parameter_description"><p>the output buffer.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> -<div class="REFSECT3"> -<a name="AEN16628"></a><h4>Returns</h4> +<div class="refsect3"> +<a name="xmlSecNodeSetDumpTextNodes.returns"></a><h4>Returns</h4> <p> 0 on success or a negative value otherwise.</p> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETDEBUGDUMP"></a><h3>xmlSecNodeSetDebugDump ()</h3> -<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">void</span></font> -xmlSecNodeSetDebugDump (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> nset</code>, - <code class="PARAMETER"><font><span class="TYPE">FILE</span></font> *output</code>);</pre> -<p>Prints information about <code class="PARAMETER">nset</code> - to the <code class="PARAMETER">output</code> +<div class="refsect2"> +<a name="xmlSecNodeSetDebugDump"></a><h3>xmlSecNodeSetDebugDump ()</h3> +<pre class="programlisting"><font><span class="returnvalue">void</span></font> +xmlSecNodeSetDebugDump (<em class="parameter"><code><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> nset</code></em>, + <em class="parameter"><code><font><span class="type">FILE</span></font> *output</code></em>);</pre> +<p>Prints information about <em class="parameter"><code>nset</code></em> + to the <em class="parameter"><code>output</code></em> .</p> -<div class="REFSECT3"> -<a name="AEN16647"></a><h4>Parameters</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16649"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetDebugDump.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>nset</p></td> -<td><p>the pointer to node set.</p></td> -<td> </td> +<td class="parameter_name"><p>nset</p></td> +<td class="parameter_description"><p>the pointer to node set.</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p>output</p></td> -<td><p>the pointer to output FILE.</p></td> -<td> </td> +<td class="parameter_name"><p>output</p></td> +<td class="parameter_description"><p>the pointer to output FILE.</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> </div> </div> -</div> -<div class="REFSECT1"> -<a name="XMLSEC-NODESET.OTHER_DETAILS"></a><h2>Types and Values</h2> -<div class="REFSECT2"> -<a name="XMLSECNODESETTYPE"></a><h3>enum xmlSecNodeSetType</h3> +<div class="refsect1"> +<a name="xmlsec-nodeset.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="xmlSecNodeSetType"></a><h3>enum xmlSecNodeSetType</h3> <p>The basic nodes sets types.</p> -<div class="REFSECT3"> -<a name="AEN16671"></a><h4>Members</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16673"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetType.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>xmlSecNodeSetNormal</p></td> -<td><p>nodes set = nodes in the list.</p></td> -<td> </td> +<td class="enum_member_name"><p><a name="xmlSecNodeSetNormal"></a>xmlSecNodeSetNormal</p></td> +<td class="enum_member_description"><p>nodes set = nodes in the list.</p></td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p>xmlSecNodeSetInvert</p></td> -<td><p>nodes set = all document nodes minus nodes in the list.</p></td> -<td> </td> +<td class="enum_member_name"><p><a name="xmlSecNodeSetInvert"></a>xmlSecNodeSetInvert</p></td> +<td class="enum_member_description"><p>nodes set = all document nodes minus nodes in the list.</p></td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p>xmlSecNodeSetTree</p></td> -<td><p>nodes set = nodes in the list and all their subtress.</p></td> -<td> </td> +<td class="enum_member_name"><p><a name="xmlSecNodeSetTree"></a>xmlSecNodeSetTree</p></td> +<td class="enum_member_description"><p>nodes set = nodes in the list and all their subtress.</p></td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p>xmlSecNodeSetTreeWithoutComments</p></td> -<td><p>nodes set = nodes in the list and +<td class="enum_member_name"><p><a name="xmlSecNodeSetTreeWithoutComments"></a>xmlSecNodeSetTreeWithoutComments</p></td> +<td class="enum_member_description"><p>nodes set = nodes in the list and all their subtress but no comment nodes.</p></td> -<td> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p>xmlSecNodeSetTreeInvert</p></td> -<td><p>nodes set = all document nodes minus nodes in the +<td class="enum_member_name"><p><a name="xmlSecNodeSetTreeInvert"></a>xmlSecNodeSetTreeInvert</p></td> +<td class="enum_member_description"><p>nodes set = all document nodes minus nodes in the list and all their subtress.</p></td> -<td> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p>xmlSecNodeSetTreeWithoutCommentsInvert</p></td> -<td><p>nodes set = all document nodes +<td class="enum_member_name"><p><a name="xmlSecNodeSetTreeWithoutCommentsInvert"></a>xmlSecNodeSetTreeWithoutCommentsInvert</p></td> +<td class="enum_member_description"><p>nodes set = all document nodes minus (nodes in the list and all their subtress plus all comment nodes).</p></td> -<td> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p>xmlSecNodeSetList</p></td> -<td><p>nodes set = all nodes in the chidren list of nodes sets.</p></td> -<td> </td> +<td class="enum_member_name"><p><a name="xmlSecNodeSetList"></a>xmlSecNodeSetList</p></td> +<td class="enum_member_description"><p>nodes set = all nodes in the children list of nodes sets.</p></td> +<td class="enum_member_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESETOP"></a><h3>enum xmlSecNodeSetOp</h3> +<div class="refsect2"> +<a name="xmlSecNodeSetOp"></a><h3>enum xmlSecNodeSetOp</h3> <p>The simple nodes sets operations.</p> -<div class="REFSECT3"> -<a name="AEN16723"></a><h4>Members</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16725"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSetOp.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p>xmlSecNodeSetIntersection</p></td> -<td><p>intersection.</p></td> -<td> </td> +<td class="enum_member_name"><p><a name="xmlSecNodeSetIntersection"></a>xmlSecNodeSetIntersection</p></td> +<td class="enum_member_description"><p>intersection.</p></td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p>xmlSecNodeSetSubtraction</p></td> -<td><p>subtraction.</p></td> -<td> </td> +<td class="enum_member_name"><p><a name="xmlSecNodeSetSubtraction"></a>xmlSecNodeSetSubtraction</p></td> +<td class="enum_member_description"><p>subtraction.</p></td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p>xmlSecNodeSetUnion</p></td> -<td><p>union.</p></td> -<td> </td> +<td class="enum_member_name"><p><a name="xmlSecNodeSetUnion"></a>xmlSecNodeSetUnion</p></td> +<td class="enum_member_description"><p>union.</p></td> +<td class="enum_member_annotations"> </td> </tr> </tbody> -</table> -<p></p> -</div> +</table></div> </div> </div> <hr> -<div class="REFSECT2"> -<a name="XMLSECNODESET"></a><h3>struct xmlSecNodeSet</h3> -<pre class="PROGRAMLISTING">struct xmlSecNodeSet { +<div class="refsect2"> +<a name="xmlSecNodeSet"></a><h3>struct xmlSecNodeSet</h3> +<pre class="programlisting">struct xmlSecNodeSet { xmlNodeSetPtr nodes; xmlDocPtr doc; int destroyDoc; @@ -801,71 +716,68 @@ xmlSecNodeSetDebugDump (<code class="PARAMETER"><a href="xmlsec-nodeset.html#XML xmlSecNodeSetPtr next; xmlSecNodeSetPtr prev; xmlSecNodeSetPtr children; -};</pre> +}; +</pre> <p>The enchanced nodes set.</p> -<div class="REFSECT3"> -<a name="AEN16752"></a><h4>Members</h4> -<div class="INFORMALTABLE"> -<p></p> -<a name="AEN16754"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<div class="refsect3"> +<a name="xmlSecNodeSet.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> <col> <col> <col> +</colgroup> <tbody> <tr> -<td><p><font><span class="TYPE">xmlNodeSetPtr</span></font> <code class="STRUCTFIELD">nodes</code>;</p></td> -<td><p>the nodes list.</p></td> -<td> </td> +<td class="struct_member_name"><p><font><span class="type">xmlNodeSetPtr</span></font> <em class="structfield"><code><a name="xmlSecNodeSet.nodes"></a>nodes</code></em>;</p></td> +<td class="struct_member_description"><p>the nodes list.</p></td> +<td class="struct_member_annotations"> </td> </tr> <tr> -<td><p><font><span class="TYPE">xmlDocPtr</span></font> <code class="STRUCTFIELD">doc</code>;</p></td> -<td><p>the parent XML document.</p></td> -<td> </td> +<td class="struct_member_name"><p><font><span class="type">xmlDocPtr</span></font> <em class="structfield"><code><a name="xmlSecNodeSet.doc"></a>doc</code></em>;</p></td> +<td class="struct_member_description"><p>the parent XML document.</p></td> +<td class="struct_member_annotations"> </td> </tr> <tr> -<td><p><font><span class="TYPE">int</span></font> <code class="STRUCTFIELD">destroyDoc</code>;</p></td> -<td><p>the flag: if set to 1 then <code class="PARAMETER">doc</code> +<td class="struct_member_name"><p><font><span class="type">int</span></font> <em class="structfield"><code><a name="xmlSecNodeSet.destroyDoc"></a>destroyDoc</code></em>;</p></td> +<td class="struct_member_description"><p>the flag: if set to 1 then <em class="parameter"><code>doc</code></em> will be destroyed when node set is destroyed.</p></td> -<td> </td> +<td class="struct_member_annotations"> </td> </tr> <tr> -<td><p><a href="xmlsec-nodeset.html#XMLSECNODESETTYPE"><span class="TYPE">xmlSecNodeSetType</span></a> <code class="STRUCTFIELD">type</code>;</p></td> -<td><p>the nodes set type.</p></td> -<td> </td> +<td class="struct_member_name"><p><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetType" title="enum xmlSecNodeSetType"><span class="type">xmlSecNodeSetType</span></a> <em class="structfield"><code><a name="xmlSecNodeSet.type"></a>type</code></em>;</p></td> +<td class="struct_member_description"><p>the nodes set type.</p></td> +<td class="struct_member_annotations"> </td> </tr> <tr> -<td><p><a href="xmlsec-nodeset.html#XMLSECNODESETOP"><span class="TYPE">xmlSecNodeSetOp</span></a> <code class="STRUCTFIELD">op</code>;</p></td> -<td><p>the operation type.</p></td> -<td> </td> +<td class="struct_member_name"><p><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetOp" title="enum xmlSecNodeSetOp"><span class="type">xmlSecNodeSetOp</span></a> <em class="structfield"><code><a name="xmlSecNodeSet.op"></a>op</code></em>;</p></td> +<td class="struct_member_description"><p>the operation type.</p></td> +<td class="struct_member_annotations"> </td> </tr> <tr> -<td><p><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> <code class="STRUCTFIELD">next</code>;</p></td> -<td><p>the next nodes set.</p></td> -<td> </td> +<td class="struct_member_name"><p><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> <em class="structfield"><code><a name="xmlSecNodeSet.next"></a>next</code></em>;</p></td> +<td class="struct_member_description"><p>the next nodes set.</p></td> +<td class="struct_member_annotations"> </td> </tr> <tr> -<td><p><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> <code class="STRUCTFIELD">prev</code>;</p></td> -<td><p>the previous nodes set.</p></td> -<td> </td> +<td class="struct_member_name"><p><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> <em class="structfield"><code><a name="xmlSecNodeSet.prev"></a>prev</code></em>;</p></td> +<td class="struct_member_description"><p>the previous nodes set.</p></td> +<td class="struct_member_annotations"> </td> </tr> <tr> -<td><p><a href="xmlsec-nodeset.html#XMLSECNODESET"><span class="TYPE">xmlSecNodeSetPtr</span></a> <code class="STRUCTFIELD">children</code>;</p></td> -<td><p>the children list (valid only if type -equal to <a href="xmlsec-nodeset.html#XMLSECNODESETLIST"><span class="TYPE">xmlSecNodeSetList</span></a>).</p></td> -<td> </td> +<td class="struct_member_name"><p><a class="link" href="xmlsec-nodeset.html#xmlSecNodeSet" title="struct xmlSecNodeSet"><span class="type">xmlSecNodeSetPtr</span></a> <em class="structfield"><code><a name="xmlSecNodeSet.children"></a>children</code></em>;</p></td> +<td class="struct_member_description"><p>the children list (valid only if type +equal to <a class="link" href="xmlsec-nodeset.html#xmlSecNodeSetList"><span class="type">xmlSecNodeSetList</span></a>).</p></td> +<td class="struct_member_annotations"> </td> </tr> </tbody> -</table> -<p></p> +</table></div> </div> </div> </div> </div> -<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle"> -<td align="left"><a accesskey="p" href="xmlsec-membuf.html"><b><<< membuf</b></a></td> -<td align="right"><a accesskey="n" href="xmlsec-parser.html"><b>parser >>></b></a></td> -</tr></table> -</td></tr></table></td> -</tr></table></body> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> </html> |