<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>list</title>
<meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.7">
<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="keysmngr" href="xmlsec-keysmngr.html">
<link rel="NEXT" title="membuf" href="xmlsec-membuf.html">
<meta name="GENERATOR" content="GTK-Doc V1.2 (SGML mode)">
<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>
</head>
<body><table witdh="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>
</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-keysmngr.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="xmlsec-ref.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">XML Security Library Reference Manual</th>
<td><a accesskey="n" href="xmlsec-membuf.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<h1>
<a name="XMLSEC-LIST"></a>list</h1>
<div class="REFNAMEDIV">
<a name="AEN11251"></a><h2>Name</h2>list--Generic list structure implementation.</div>
<div class="REFSYNOPSISDIV">
<a name="AEN11254"></a><h2>Synopsis</h2>
<pre class="SYNOPSIS">
struct <a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrList</a>;
<font>void</font> <a href="xmlsec-list.html#XMLSECPTRLISTSETDEFAULTALLOCMODE">xmlSecPtrListSetDefaultAllocMode</a>
(<a href="xmlsec-buffer.html#XMLSECALLOCMODE">xmlSecAllocMode</a> defAllocMode,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> defInitialSize);
<font>int</font> <a href="xmlsec-list.html#XMLSECPTRLISTINITIALIZE">xmlSecPtrListInitialize</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>xmlSecPtrListId</font> id);
<font>void</font> <a href="xmlsec-list.html#XMLSECPTRLISTFINALIZE">xmlSecPtrListFinalize</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);
<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> <a href="xmlsec-list.html#XMLSECPTRLISTCREATE">xmlSecPtrListCreate</a> (<font>xmlSecPtrListId</font> id);
<font>void</font> <a href="xmlsec-list.html#XMLSECPTRLISTDESTROY">xmlSecPtrListDestroy</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);
<font>void</font> <a href="xmlsec-list.html#XMLSECPTRLISTEMPTY">xmlSecPtrListEmpty</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);
<font>int</font> <a href="xmlsec-list.html#XMLSECPTRLISTCOPY">xmlSecPtrListCopy</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> dst,
<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> src);
<font>xmlSecPtrListPtr</font> <a href="xmlsec-list.html#XMLSECPTRLISTDUPLICATE">xmlSecPtrListDuplicate</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> <a href="xmlsec-list.html#XMLSECPTRLISTGETSIZE">xmlSecPtrListGetSize</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);
<a href="xmlsec-xmlsec.html#XMLSECPTR">xmlSecPtr</a> <a href="xmlsec-list.html#XMLSECPTRLISTGETITEM">xmlSecPtrListGetItem</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> pos);
<font>int</font> <a href="xmlsec-list.html#XMLSECPTRLISTADD">xmlSecPtrListAdd</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>xmlSecPtr</font> item);
<font>int</font> <a href="xmlsec-list.html#XMLSECPTRLISTSET">xmlSecPtrListSet</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>xmlSecPtr</font> item,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> pos);
<font>int</font> <a href="xmlsec-list.html#XMLSECPTRLISTREMOVE">xmlSecPtrListRemove</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> pos);
<font>void</font> <a href="xmlsec-list.html#XMLSECPTRLISTDEBUGDUMP">xmlSecPtrListDebugDump</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>FILE</font> *output);
<font>void</font> <a href="xmlsec-list.html#XMLSECPTRLISTDEBUGXMLDUMP">xmlSecPtrListDebugXmlDump</a> (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>FILE</font> *output);
#define <a href="xmlsec-list.html#XMLSECPTRLISTGETNAME">xmlSecPtrListGetName</a> (list)
#define <a href="xmlsec-list.html#XMLSECPTRLISTISVALID">xmlSecPtrListIsValid</a> (list)
#define <a href="xmlsec-list.html#XMLSECPTRLISTCHECKID">xmlSecPtrListCheckId</a> (list, dataId)
#define <a href="xmlsec-list.html#XMLSECPTRLISTIDUNKNOWN">xmlSecPtrListIdUnknown</a>
<a href="xmlsec-xmlsec.html#XMLSECPTR">xmlSecPtr</a> (<a href="xmlsec-list.html#XMLSECPTRDUPLICATEITEMMETHOD">*xmlSecPtrDuplicateItemMethod</a>) (<font>xmlSecPtr</font> ptr);
<font>void</font> (<a href="xmlsec-list.html#XMLSECPTRDESTROYITEMMETHOD">*xmlSecPtrDestroyItemMethod</a>) (<font>xmlSecPtr</font> ptr);
<font>void</font> (<a href="xmlsec-list.html#XMLSECPTRDEBUGDUMPITEMMETHOD">*xmlSecPtrDebugDumpItemMethod</a>) (<font>xmlSecPtr</font> ptr,
<font>FILE</font> *output);
struct <a href="xmlsec-list.html#XMLSECPTRLISTKLASS">xmlSecPtrListKlass</a>;
#define <a href="xmlsec-list.html#XMLSECPTRLISTKLASSGETNAME">xmlSecPtrListKlassGetName</a> (klass)
#define <a href="xmlsec-list.html#XMLSECSTRINGLISTID">xmlSecStringListId</a>
<font>xmlSecPtrListId</font> <a href="xmlsec-list.html#XMLSECSTRINGLISTGETKLASS">xmlSecStringListGetKlass</a> (void);</pre>
</div>
<div class="REFSECT1">
<a name="AEN11332"></a><h2>Description</h2>
<p>Generic list structure implementation.</p>
</div>
<div class="REFSECT1">
<a name="AEN11335"></a><h2>Details</h2>
<div class="REFSECT2">
<a name="AEN11337"></a><h3>
<a name="XMLSECPTRLIST"></a>struct xmlSecPtrList</h3>
<pre class="PROGRAMLISTING">struct xmlSecPtrList {
xmlSecPtrListId id;
xmlSecPtr* data;
xmlSecSize use;
xmlSecSize max;
xmlSecAllocMode allocMode;
};</pre>
<p>The pointers list.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11346"><span style="white-space: nowrap"><font>xmlSecPtrListId</font> <code class="STRUCTFIELD">id</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the list items description.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11352"><span style="white-space: nowrap"><font>xmlSecPtr</font> *<code class="STRUCTFIELD">data</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the list data.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11358"><span style="white-space: nowrap"><a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> <code class="STRUCTFIELD">use</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the current list size.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11364"><span style="white-space: nowrap"><a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> <code class="STRUCTFIELD">max</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the max (allocated) list size.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11370"><span style="white-space: nowrap"><a href="xmlsec-buffer.html#XMLSECALLOCMODE">xmlSecAllocMode</a> <code class="STRUCTFIELD">allocMode</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the memory allocation mode.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11376"></a><h3>
<a name="XMLSECPTRLISTSETDEFAULTALLOCMODE"></a>xmlSecPtrListSetDefaultAllocMode ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> xmlSecPtrListSetDefaultAllocMode
(<a href="xmlsec-buffer.html#XMLSECALLOCMODE">xmlSecAllocMode</a> defAllocMode,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> defInitialSize);</pre>
<p>Sets new default allocation mode and minimal initial list size.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11388"><span style="white-space: nowrap"><var class="PARAMETER">defAllocMode</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the new default memory allocation mode.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11393"><span style="white-space: nowrap"><var class="PARAMETER">defInitialSize</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the new default minimal initial size.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11398"></a><h3>
<a name="XMLSECPTRLISTINITIALIZE"></a>xmlSecPtrListInitialize ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecPtrListInitialize (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>xmlSecPtrListId</font> id);</pre>
<p>Initializes the list of given klass. Caller is responsible
for cleaning up by calling <a href="xmlsec-list.html#XMLSECPTRLISTFINALIZE"><span class="TYPE">xmlSecPtrListFinalize</span></a> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11412"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11417"><span style="white-space: nowrap"><var class="PARAMETER">id</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the list klass.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11422"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11427"></a><h3>
<a name="XMLSECPTRLISTFINALIZE"></a>xmlSecPtrListFinalize ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> xmlSecPtrListFinalize (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);</pre>
<p>Cleans up the list initialized with <a href="xmlsec-list.html#XMLSECPTRLISTINITIALIZE"><span class="TYPE">xmlSecPtrListInitialize</span></a>
function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN11440"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11445"></a><h3>
<a name="XMLSECPTRLISTCREATE"></a>xmlSecPtrListCreate ()</h3>
<pre class="PROGRAMLISTING"><a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> xmlSecPtrListCreate (<font>xmlSecPtrListId</font> id);</pre>
<p>Creates new list object. Caller is responsible for freeing returned list
by calling <a href="xmlsec-list.html#XMLSECPTRLISTDESTROY"><span class="TYPE">xmlSecPtrListDestroy</span></a> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11458"><span style="white-space: nowrap"><var class="PARAMETER">id</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the list klass.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11463"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>pointer to newly allocated list or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11468"></a><h3>
<a name="XMLSECPTRLISTDESTROY"></a>xmlSecPtrListDestroy ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> xmlSecPtrListDestroy (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);</pre>
<p>Destroys <var class="PARAMETER">list</var> created with <a href="xmlsec-list.html#XMLSECPTRLISTCREATE"><span class="TYPE">xmlSecPtrListCreate</span></a> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN11482"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11487"></a><h3>
<a name="XMLSECPTRLISTEMPTY"></a>xmlSecPtrListEmpty ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> xmlSecPtrListEmpty (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);</pre>
<p>Remove all items from <var class="PARAMETER">list</var> (if any).</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN11499"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11504"></a><h3>
<a name="XMLSECPTRLISTCOPY"></a>xmlSecPtrListCopy ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecPtrListCopy (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> dst,
<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> src);</pre>
<p>Copies <var class="PARAMETER">src</var> list items to <var class="PARAMETER">dst</var> list using <font><span class="TYPE">duplicateItem</span></font> method
of the list klass. If <font><span class="TYPE">duplicateItem</span></font> method is NULL then
we jsut copy pointers to items.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11522"><span style="white-space: nowrap"><var class="PARAMETER">dst</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to destination list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11527"><span style="white-space: nowrap"><var class="PARAMETER">src</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to source list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11532"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11537"></a><h3>
<a name="XMLSECPTRLISTDUPLICATE"></a>xmlSecPtrListDuplicate ()</h3>
<pre class="PROGRAMLISTING"><font>xmlSecPtrListPtr</font> xmlSecPtrListDuplicate (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);</pre>
<p>Creates a new copy of <var class="PARAMETER">list</var> and all its items.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11549"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11554"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>pointer to newly allocated list or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11559"></a><h3>
<a name="XMLSECPTRLISTGETSIZE"></a>xmlSecPtrListGetSize ()</h3>
<pre class="PROGRAMLISTING"><a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> xmlSecPtrListGetSize (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list);</pre>
<p>Gets list size.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11570"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11575"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>the number of itmes in <var class="PARAMETER">list</var>.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11581"></a><h3>
<a name="XMLSECPTRLISTGETITEM"></a>xmlSecPtrListGetItem ()</h3>
<pre class="PROGRAMLISTING"><a href="xmlsec-xmlsec.html#XMLSECPTR">xmlSecPtr</a> xmlSecPtrListGetItem (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> pos);</pre>
<p>Gets item from the list.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11593"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11598"><span style="white-space: nowrap"><var class="PARAMETER">pos</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the item position.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11603"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>the list item at position <var class="PARAMETER">pos</var> or NULL if <var class="PARAMETER">pos</var> is greater
than the number of items in the list or an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11610"></a><h3>
<a name="XMLSECPTRLISTADD"></a>xmlSecPtrListAdd ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecPtrListAdd (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>xmlSecPtr</font> item);</pre>
<p>Adds <var class="PARAMETER">item</var> to the end of the <var class="PARAMETER">list</var>.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11624"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11629"><span style="white-space: nowrap"><var class="PARAMETER">item</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the item.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11634"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11639"></a><h3>
<a name="XMLSECPTRLISTSET"></a>xmlSecPtrListSet ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecPtrListSet (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>xmlSecPtr</font> item,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> pos);</pre>
<p>Sets the value of list item at position <var class="PARAMETER">pos</var>. The old value
is destroyed.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11653"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11658"><span style="white-space: nowrap"><var class="PARAMETER">item</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the item.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11663"><span style="white-space: nowrap"><var class="PARAMETER">pos</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pos.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11668"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11673"></a><h3>
<a name="XMLSECPTRLISTREMOVE"></a>xmlSecPtrListRemove ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecPtrListRemove (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> pos);</pre>
<p>Destroys list item at the position <var class="PARAMETER">pos</var> and sets it value to NULL.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11686"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11691"><span style="white-space: nowrap"><var class="PARAMETER">pos</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the position.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11696"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11701"></a><h3>
<a name="XMLSECPTRLISTDEBUGDUMP"></a>xmlSecPtrListDebugDump ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> xmlSecPtrListDebugDump (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>FILE</font> *output);</pre>
<p>Prints debug information about <var class="PARAMETER">list</var> to the <var class="PARAMETER">output</var>.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11715"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11720"><span style="white-space: nowrap"><var class="PARAMETER">output</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to output FILE.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11725"></a><h3>
<a name="XMLSECPTRLISTDEBUGXMLDUMP"></a>xmlSecPtrListDebugXmlDump ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> xmlSecPtrListDebugXmlDump (<a href="xmlsec-list.html#XMLSECPTRLIST">xmlSecPtrListPtr</a> list,
<font>FILE</font> *output);</pre>
<p>Prints debug information about <var class="PARAMETER">list</var> to the <var class="PARAMETER">output</var> in XML format.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11739"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11744"><span style="white-space: nowrap"><var class="PARAMETER">output</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to output FILE.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11749"></a><h3>
<a name="XMLSECPTRLISTGETNAME"></a>xmlSecPtrListGetName()</h3>
<pre class="PROGRAMLISTING">#define xmlSecPtrListGetName(list)</pre>
<p>Macro. Returns lists's name.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN11758"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the ponter to list.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11763"></a><h3>
<a name="XMLSECPTRLISTISVALID"></a>xmlSecPtrListIsValid()</h3>
<pre class="PROGRAMLISTING">#define xmlSecPtrListIsValid(list)</pre>
<p>Macro. Returns 1 if <var class="PARAMETER">list</var> is not NULL and <var class="PARAMETER">list</var>->id is not NULL
or 0 otherwise.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN11774"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11779"></a><h3>
<a name="XMLSECPTRLISTCHECKID"></a>xmlSecPtrListCheckId()</h3>
<pre class="PROGRAMLISTING">#define xmlSecPtrListCheckId(list, dataId)</pre>
<p>Macro. Returns 1 if <var class="PARAMETER">list</var> is valid and <var class="PARAMETER">list</var>'s id is equal to <var class="PARAMETER">dataId</var>.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11791"><span style="white-space: nowrap"><var class="PARAMETER">list</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to list.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11796"><span style="white-space: nowrap"><var class="PARAMETER">dataId</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the list Id.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11801"></a><h3>
<a name="XMLSECPTRLISTIDUNKNOWN"></a>xmlSecPtrListIdUnknown</h3>
<pre class="PROGRAMLISTING">#define xmlSecPtrListIdUnknown NULL</pre>
<p>The "unknown" id.</p>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11809"></a><h3>
<a name="XMLSECPTRDUPLICATEITEMMETHOD"></a>xmlSecPtrDuplicateItemMethod ()</h3>
<pre class="PROGRAMLISTING"><a href="xmlsec-xmlsec.html#XMLSECPTR">xmlSecPtr</a> (*xmlSecPtrDuplicateItemMethod) (<font>xmlSecPtr</font> ptr);</pre>
<p>Duplicates item <var class="PARAMETER">ptr</var>.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11821"><span style="white-space: nowrap"><var class="PARAMETER">ptr</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the poinetr to list item.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11826"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>pointer to new item copy or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11831"></a><h3>
<a name="XMLSECPTRDESTROYITEMMETHOD"></a>xmlSecPtrDestroyItemMethod ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> (*xmlSecPtrDestroyItemMethod) (<font>xmlSecPtr</font> ptr);</pre>
<p>Destroys list item <var class="PARAMETER">ptr</var>.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN11843"><span style="white-space: nowrap"><var class="PARAMETER">ptr</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the poinetr to list item.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11848"></a><h3>
<a name="XMLSECPTRDEBUGDUMPITEMMETHOD"></a>xmlSecPtrDebugDumpItemMethod ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> (*xmlSecPtrDebugDumpItemMethod) (<font>xmlSecPtr</font> ptr,
<font>FILE</font> *output);</pre>
<p>Prints debug information about <var class="PARAMETER">item</var> to <var class="PARAMETER">output</var>.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11862"><span style="white-space: nowrap"><var class="PARAMETER">ptr</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the poinetr to list item.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11867"><span style="white-space: nowrap"><var class="PARAMETER">output</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the output FILE.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11872"></a><h3>
<a name="XMLSECPTRLISTKLASS"></a>struct xmlSecPtrListKlass</h3>
<pre class="PROGRAMLISTING">struct xmlSecPtrListKlass {
const xmlChar* name;
xmlSecPtrDuplicateItemMethod duplicateItem;
xmlSecPtrDestroyItemMethod destroyItem;
xmlSecPtrDebugDumpItemMethod debugDumpItem;
xmlSecPtrDebugDumpItemMethod debugXmlDumpItem;
};</pre>
<p>List klass.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11881"><span style="white-space: nowrap">const <font>xmlChar</font> *<code class="STRUCTFIELD">name</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the list klass name.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11887"><span style="white-space: nowrap"><a href="xmlsec-list.html#XMLSECPTRDUPLICATEITEMMETHOD">xmlSecPtrDuplicateItemMethod</a> <code class="STRUCTFIELD">duplicateItem</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the duplciate item method.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11893"><span style="white-space: nowrap"><a href="xmlsec-list.html#XMLSECPTRDESTROYITEMMETHOD">xmlSecPtrDestroyItemMethod</a> <code class="STRUCTFIELD">destroyItem</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the destroy item method.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11899"><span style="white-space: nowrap"><a href="xmlsec-list.html#XMLSECPTRDEBUGDUMPITEMMETHOD">xmlSecPtrDebugDumpItemMethod</a> <code class="STRUCTFIELD">debugDumpItem</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the debug dump item method.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11905"><span style="white-space: nowrap"><a href="xmlsec-list.html#XMLSECPTRDEBUGDUMPITEMMETHOD">xmlSecPtrDebugDumpItemMethod</a> <code class="STRUCTFIELD">debugXmlDumpItem</code></span></a></td>
<td align="LEFT" valign="TOP"><p> the debug dump item in xml format method.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11911"></a><h3>
<a name="XMLSECPTRLISTKLASSGETNAME"></a>xmlSecPtrListKlassGetName()</h3>
<pre class="PROGRAMLISTING">#define xmlSecPtrListKlassGetName(klass)</pre>
<p>Macro. Returns the list klass name.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN11920"><span style="white-space: nowrap"><var class="PARAMETER">klass</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the list klass.
2</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11925"></a><h3>
<a name="XMLSECSTRINGLISTID"></a>xmlSecStringListId</h3>
<pre class="PROGRAMLISTING">#define xmlSecStringListId</pre>
<p>Strings list klass.</p>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11933"></a><h3>
<a name="XMLSECSTRINGLISTGETKLASS"></a>xmlSecStringListGetKlass ()</h3>
<pre class="PROGRAMLISTING"><font>xmlSecPtrListId</font> xmlSecStringListGetKlass (void);</pre>
<p>The strins list class.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN11943"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>strings list klass.</p></td>
</tr></tbody></table>
</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-keysmngr.html"><b><<<keysmngr</b></a></td>
<td align="right"><a accesskey="n" href="xmlsec-membuf.html"><b>membuf>>></b></a></td>
</tr></table>
</td></tr></table></td>
</tr></table></body>
</html>
