|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/22697/root/usr/share/doc/xmlsec1/api/ |
Upload File : |
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>parser</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="nodeset" href="xmlsec-nodeset.html">
<link rel="NEXT" title="templates" href="xmlsec-templates.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>
<!--Sponsored links - start--><!--Sponsored 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-nodeset.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-templates.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<h1>
<a name="XMLSEC-PARSER"></a>parser</h1>
<div class="REFNAMEDIV">
<a name="AEN11848"></a><h2>Name</h2>parser -- </div>
<div class="REFSYNOPSISDIV">
<a name="AEN11851"></a><h2>Synopsis</h2>
<pre class="SYNOPSIS">
<font>xmlDocPtr</font> <a href="xmlsec-parser.html#XMLSECPARSEFILE">xmlSecParseFile</a> (const <font>char</font> *filename);
<font>xmlDocPtr</font> <a href="xmlsec-parser.html#XMLSECPARSEMEMORY">xmlSecParseMemory</a> (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buffer,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> size,
<font>int</font> recovery);
<font>xmlDocPtr</font> <a href="xmlsec-parser.html#XMLSECPARSEMEMORYEXT">xmlSecParseMemoryExt</a> (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *prefix,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> prefixSize,
const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buffer,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> bufferSize,
const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *postfix,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> postfixSize);
#define <a href="xmlsec-parser.html#XMLSECTRANSFORMXMLPARSERID">xmlSecTransformXmlParserId</a>
<font>xmlSecTransformId</font> <a href="xmlsec-parser.html#XMLSECTRANSFORMXMLPARSERGETKLASS">xmlSecTransformXmlParserGetKlass</a>
(void);</pre>
</div>
<div class="REFSECT1">
<a name="AEN11873"></a><h2>Description</h2>
<p></p>
</div>
<div class="REFSECT1">
<a name="AEN11876"></a><h2>Details</h2>
<div class="REFSECT2">
<a name="AEN11878"></a><h3>
<a name="XMLSECPARSEFILE"></a>xmlSecParseFile ()</h3>
<pre class="PROGRAMLISTING"><font>xmlDocPtr</font> xmlSecParseFile (const <font>char</font> *filename);</pre>
<p>Loads XML Doc from file <var class="PARAMETER">filename</var>. We need a special version because of
c14n issue. The code is copied from <font><code class="FUNCTION">xmlSAXParseFileWithData()</code></font> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11892"><span style="white-space: nowrap"><var class="PARAMETER">filename</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the filename.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11897"><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 the loaded XML document or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11902"></a><h3>
<a name="XMLSECPARSEMEMORY"></a>xmlSecParseMemory ()</h3>
<pre class="PROGRAMLISTING"><font>xmlDocPtr</font> xmlSecParseMemory (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buffer,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> size,
<font>int</font> recovery);</pre>
<p>Loads XML Doc from memory. We need a special version because of
c14n issue. The code is copied from <font><code class="FUNCTION">xmlSAXParseMemory()</code></font> function.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11917"><span style="white-space: nowrap"><var class="PARAMETER">buffer</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the input buffer.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11922"><span style="white-space: nowrap"><var class="PARAMETER">size</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the input buffer size.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11927"><span style="white-space: nowrap"><var class="PARAMETER">recovery</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the flag.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11932"><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 the loaded XML document or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11937"></a><h3>
<a name="XMLSECPARSEMEMORYEXT"></a>xmlSecParseMemoryExt ()</h3>
<pre class="PROGRAMLISTING"><font>xmlDocPtr</font> xmlSecParseMemoryExt (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *prefix,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> prefixSize,
const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buffer,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> bufferSize,
const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *postfix,
<a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> postfixSize);</pre>
<p>Loads XML Doc from 3 chunks of memory: <var class="PARAMETER">prefix</var>, <var class="PARAMETER">buffer</var> and <var class="PARAMETER">postfix</var>.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11956"><span style="white-space: nowrap"><var class="PARAMETER">prefix</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the first part of the input.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11961"><span style="white-space: nowrap"><var class="PARAMETER">prefixSize</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the size of the first part of the input.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11966"><span style="white-space: nowrap"><var class="PARAMETER">buffer</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the second part of the input.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11971"><span style="white-space: nowrap"><var class="PARAMETER">bufferSize</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the size of the second part of the input.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11976"><span style="white-space: nowrap"><var class="PARAMETER">postfix</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the third part of the input.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11981"><span style="white-space: nowrap"><var class="PARAMETER">postfixSize</var> :</span></a></td>
<td align="LEFT" valign="TOP"><p> the size of the third part of the input.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN11986"><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 the loaded XML document or NULL if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11991"></a><h3>
<a name="XMLSECTRANSFORMXMLPARSERID"></a>xmlSecTransformXmlParserId</h3>
<pre class="PROGRAMLISTING">#define xmlSecTransformXmlParserId</pre>
<p>The XML Parser transform klass.</p>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN11999"></a><h3>
<a name="XMLSECTRANSFORMXMLPARSERGETKLASS"></a>xmlSecTransformXmlParserGetKlass ()</h3>
<pre class="PROGRAMLISTING"><font>xmlSecTransformId</font> xmlSecTransformXmlParserGetKlass
(void);</pre>
<p>The XML parser transform.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN12009"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>XML parser transform 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-nodeset.html"><b><<< nodeset</b></a></td>
<td align="right"><a accesskey="n" href="xmlsec-templates.html"><b>templates >>></b></a></td>
</tr></table>
</td></tr></table></td>
</tr></table></body>
</html>