/
githubmirror
/
xmlsec
Обзор
Документация
Войти
/
githubmirror
/
xmlsec
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
1.3.10
docs/api/xmlsec-parser.html
377 строк
16 KB
lsh123
Update docs (#1082)
18 мар 2026, 04:43
Не верифицирован
18 мар 2026, 04:43
ff1e861
Код
Авторство
О чём код?
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>parser: XML Security Library Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> <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-nodeset.html" title="nodeset"> <link rel="next" href="xmlsec-templates.html" title="templates"> <meta name="generator" content="GTK-Doc V1.34.0 (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> <ul><li><a href="../https://github.com/lsh123/xmlsec">GitHub</a></li></ul> <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> <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="mailing-list.html">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="80%" valign="top" style="margin-left:10px;"><tr><td valign="top" align="left" id="xmlsecContent"> <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-parser.description" class="shortcut">Description</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></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="p" href="xmlsec-nodeset.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="xmlsec-templates.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="xmlsec-parser"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="xmlsec-parser.top_of_page"></a>parser</span></h2> <p>parser — XML parser functions and the XML parser transform implementation.</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="xmlsec-parser.stability-level"></a><h2>Stability Level</h2> <acronym title="The intention of a Stable interface is to enable arbitrary third parties to develop applications to these interfaces, release them, and have confidence that they will run on all minor releases of the product (after the one in which the interface was introduced, and within the same major release). Even at a major release, incompatible changes are expected to be rare, and to have strong justifications. "><span class="acronym">Stable</span></acronym>, unless otherwise indicated </div> <div class="refsect1"> <a name="xmlsec-parser.functions"></a><h2>Functions</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col> <col> </colgroup> <tbody> <tr> <td class="function_type"> <font><span class="returnvalue">xmlDocPtr</span></font> </td> <td class="function_name"> <a class="link" href="xmlsec-parser.html#xmlSecParseFile" title="xmlSecParseFile ()">xmlSecParseFile</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <font><span class="returnvalue">xmlDocPtr</span></font> </td> <td class="function_name"> <a class="link" href="xmlsec-parser.html#xmlSecParseMemory" title="xmlSecParseMemory ()">xmlSecParseMemory</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <font><span class="returnvalue">xmlDocPtr</span></font> </td> <td class="function_name"> <a class="link" href="xmlsec-parser.html#xmlSecParseMemoryExt" title="xmlSecParseMemoryExt ()">xmlSecParseMemoryExt</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <font><span class="returnvalue">void</span></font> </td> <td class="function_name"> <a class="link" href="xmlsec-parser.html#xmlSecParsePrepareCtxt" title="xmlSecParsePrepareCtxt ()">xmlSecParsePrepareCtxt</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <font><span class="returnvalue">int</span></font> </td> <td class="function_name"> <a class="link" href="xmlsec-parser.html#xmlSecParserGetDefaultOptions" title="xmlSecParserGetDefaultOptions ()">xmlSecParserGetDefaultOptions</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <font><span class="returnvalue">void</span></font> </td> <td class="function_name"> <a class="link" href="xmlsec-parser.html#xmlSecParserSetDefaultOptions" title="xmlSecParserSetDefaultOptions ()">xmlSecParserSetDefaultOptions</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <font><span class="returnvalue">xmlSecTransformId</span></font> </td> <td class="function_name"> <a class="link" href="xmlsec-parser.html#xmlSecTransformXmlParserGetKlass" title="xmlSecTransformXmlParserGetKlass ()">xmlSecTransformXmlParserGetKlass</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="xmlsec-parser.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col> <col> </colgroup> <tbody><tr> <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="xmlsec-parser.html#xmlSecTransformXmlParserId" title="xmlSecTransformXmlParserId">xmlSecTransformXmlParserId</a></td> </tr></tbody> </table></div> </div> <div class="refsect1"> <a name="xmlsec-parser.description"></a><h2>Description</h2> <p></p> </div> <div class="refsect1"> <a name="xmlsec-parser.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="xmlSecParseFile"></a><h3>xmlSecParseFile ()</h3> <pre class="programlisting"><font><span class="returnvalue">xmlDocPtr</span></font> xmlSecParseFile (<em class="parameter"><code>const <font><span class="type">char</span></font> *filename</code></em>);</pre> <p>Loads XML Doc from file <em class="parameter"><code>filename</code></em> . We need a special version because of c14n issue. The code is copied from <font><code class="function">xmlSAXParseFileWithData()</code></font> function.</p> <div class="refsect3"> <a name="xmlSecParseFile.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col> <col> <col> </colgroup> <tbody><tr> <td class="parameter_name"><p>filename</p></td> <td class="parameter_description"><p>the filename.</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="xmlSecParseFile.returns"></a><h4>Returns</h4> <p> pointer to the loaded XML document or NULL if an error occurs.</p> </div> </div> <hr> <div class="refsect2"> <a name="xmlSecParseMemory"></a><h3>xmlSecParseMemory ()</h3> <pre class="programlisting"><font><span class="returnvalue">xmlDocPtr</span></font> xmlSecParseMemory (<em class="parameter"><code>const <a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte"><span class="type">xmlSecByte</span></a> *buffer</code></em>, <em class="parameter"><code><a class="link" href="xmlsec-xmlsec.html#xmlSecSize" title="xmlSecSize"><span class="type">xmlSecSize</span></a> size</code></em>, <em class="parameter"><code><font><span class="type">int</span></font> recovery</code></em>);</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> <div class="refsect3"> <a name="xmlSecParseMemory.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col> <col> <col> </colgroup> <tbody> <tr> <td class="parameter_name"><p>buffer</p></td> <td class="parameter_description"><p>the input buffer.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>size</p></td> <td class="parameter_description"><p>the input buffer size.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>recovery</p></td> <td class="parameter_description"><p>the flag.</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="xmlSecParseMemory.returns"></a><h4>Returns</h4> <p> pointer to the loaded XML document or NULL if an error occurs.</p> </div> </div> <hr> <div class="refsect2"> <a name="xmlSecParseMemoryExt"></a><h3>xmlSecParseMemoryExt ()</h3> <pre class="programlisting"><font><span class="returnvalue">xmlDocPtr</span></font> xmlSecParseMemoryExt (<em class="parameter"><code>const <a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte"><span class="type">xmlSecByte</span></a> *prefix</code></em>, <em class="parameter"><code><a class="link" href="xmlsec-xmlsec.html#xmlSecSize" title="xmlSecSize"><span class="type">xmlSecSize</span></a> prefixSize</code></em>, <em class="parameter"><code>const <a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte"><span class="type">xmlSecByte</span></a> *buffer</code></em>, <em class="parameter"><code><a class="link" href="xmlsec-xmlsec.html#xmlSecSize" title="xmlSecSize"><span class="type">xmlSecSize</span></a> bufferSize</code></em>, <em class="parameter"><code>const <a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte"><span class="type">xmlSecByte</span></a> *postfix</code></em>, <em class="parameter"><code><a class="link" href="xmlsec-xmlsec.html#xmlSecSize" title="xmlSecSize"><span class="type">xmlSecSize</span></a> postfixSize</code></em>);</pre> <p>Loads XML Doc from 3 chunks of memory: <em class="parameter"><code>prefix</code></em> , <em class="parameter"><code>buffer</code></em> and <em class="parameter"><code>postfix</code></em> .</p> <div class="refsect3"> <a name="xmlSecParseMemoryExt.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col> <col> <col> </colgroup> <tbody> <tr> <td class="parameter_name"><p>prefix</p></td> <td class="parameter_description"><p>the first part of the input.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>prefixSize</p></td> <td class="parameter_description"><p>the size of the first part of the input.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>buffer</p></td> <td class="parameter_description"><p>the second part of the input.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>bufferSize</p></td> <td class="parameter_description"><p>the size of the second part of the input.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>postfix</p></td> <td class="parameter_description"><p>the third part of the input.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>postfixSize</p></td> <td class="parameter_description"><p>the size of the third part of the input.</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="xmlSecParseMemoryExt.returns"></a><h4>Returns</h4> <p> pointer to the loaded XML document or NULL if an error occurs.</p> </div> </div> <hr> <div class="refsect2"> <a name="xmlSecParsePrepareCtxt"></a><h3>xmlSecParsePrepareCtxt ()</h3> <pre class="programlisting"><font><span class="returnvalue">void</span></font> xmlSecParsePrepareCtxt (<em class="parameter"><code><font><span class="type">xmlParserCtxtPtr</span></font> ctxt</code></em>);</pre> <p>Prepares parser context for parsing XML for XMLSec.</p> <div class="refsect3"> <a name="xmlSecParsePrepareCtxt.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col> <col> <col> </colgroup> <tbody><tr> <td class="parameter_name"><p>ctxt</p></td> <td class="parameter_description"><p>the parser context</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> </div> <hr> <div class="refsect2"> <a name="xmlSecParserGetDefaultOptions"></a><h3>xmlSecParserGetDefaultOptions ()</h3> <pre class="programlisting"><font><span class="returnvalue">int</span></font> xmlSecParserGetDefaultOptions (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>Gets default LibXML2 parser options.</p> <div class="refsect3"> <a name="xmlSecParserGetDefaultOptions.returns"></a><h4>Returns</h4> <p> the current default LibXML2 parser options.</p> </div> </div> <hr> <div class="refsect2"> <a name="xmlSecParserSetDefaultOptions"></a><h3>xmlSecParserSetDefaultOptions ()</h3> <pre class="programlisting"><font><span class="returnvalue">void</span></font> xmlSecParserSetDefaultOptions (<em class="parameter"><code><font><span class="type">int</span></font> options</code></em>);</pre> <p>Sets default LibXML2 parser options.</p> <div class="refsect3"> <a name="xmlSecParserSetDefaultOptions.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col> <col> <col> </colgroup> <tbody><tr> <td class="parameter_name"><p>options</p></td> <td class="parameter_description"><p>the new parser options.</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> </div> <hr> <div class="refsect2"> <a name="xmlSecTransformXmlParserGetKlass"></a><h3>xmlSecTransformXmlParserGetKlass ()</h3> <pre class="programlisting"><font><span class="returnvalue">xmlSecTransformId</span></font> xmlSecTransformXmlParserGetKlass (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>The XML parser transform.</p> <div class="refsect3"> <a name="xmlSecTransformXmlParserGetKlass.returns"></a><h4>Returns</h4> <p> XML parser transform klass.</p> </div> </div> </div> <div class="refsect1"> <a name="xmlsec-parser.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="xmlSecTransformXmlParserId"></a><h3>xmlSecTransformXmlParserId</h3> <pre class="programlisting">#define xmlSecTransformXmlParserId</pre> <p>The XML Parser transform klass.</p> </div> </div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.34.0</div> </td></tr></table></td> </tr></table></body> </html>