482 lines
33 KiB
HTML
482 lines
33 KiB
HTML
<!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>XQilla DOM3 API Documentation</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacexercesc.html">xercesc</a></li><li class="navelem"><a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="classxercesc_1_1DOMLSSerializer-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">xercesc::DOMLSSerializer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="DOMLSSerializer_8hpp_source.html">DOMLSSerializer.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
|
|
<tr class="memitem:a0f0b5bd3fed8a345e5be489ac8d21a01"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a0f0b5bd3fed8a345e5be489ac8d21a01">~DOMLSSerializer</a> ()</td></tr>
|
|
<tr class="memdesc:a0f0b5bd3fed8a345e5be489ac8d21a01"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a0f0b5bd3fed8a345e5be489ac8d21a01">More...</a><br/></td></tr>
|
|
<tr class="separator:a0f0b5bd3fed8a345e5be489ac8d21a01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
|
|
<tr class="memitem:aaf0e8286a9f19e459bc1ea4c5ab2c49a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMConfiguration.html">DOMConfiguration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#aaf0e8286a9f19e459bc1ea4c5ab2c49a">getDomConfig</a> ()=0</td></tr>
|
|
<tr class="memdesc:aaf0e8286a9f19e459bc1ea4c5ab2c49a"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classxercesc_1_1DOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> object used by the LSSerializer when serializing a DOM node. <a href="#aaf0e8286a9f19e459bc1ea4c5ab2c49a">More...</a><br/></td></tr>
|
|
<tr class="separator:aaf0e8286a9f19e459bc1ea4c5ab2c49a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43effa49c56258bd51ac7fddea8245c1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a43effa49c56258bd51ac7fddea8245c1">setNewLine</a> (const XMLCh *const newLine)=0</td></tr>
|
|
<tr class="memdesc:a43effa49c56258bd51ac7fddea8245c1"><td class="mdescLeft"> </td><td class="mdescRight">The end-of-line sequence of characters to be used in the XML being written out. <a href="#a43effa49c56258bd51ac7fddea8245c1">More...</a><br/></td></tr>
|
|
<tr class="separator:a43effa49c56258bd51ac7fddea8245c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad984a18ce922002cc6d9be54cb2de7ae"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#ad984a18ce922002cc6d9be54cb2de7ae">setFilter</a> (<a class="el" href="classxercesc_1_1DOMLSSerializerFilter.html">DOMLSSerializerFilter</a> *filter)=0</td></tr>
|
|
<tr class="memdesc:ad984a18ce922002cc6d9be54cb2de7ae"><td class="mdescLeft"> </td><td class="mdescRight">When the application provides a filter, the serializer will call out to the filter before serializing each Node. <a href="#ad984a18ce922002cc6d9be54cb2de7ae">More...</a><br/></td></tr>
|
|
<tr class="separator:ad984a18ce922002cc6d9be54cb2de7ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9dbcf38438186863844ef44a2226ee0a"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a9dbcf38438186863844ef44a2226ee0a">getNewLine</a> () const =0</td></tr>
|
|
<tr class="memdesc:a9dbcf38438186863844ef44a2226ee0a"><td class="mdescLeft"> </td><td class="mdescRight">Return the end-of-line sequence of characters to be used in the XML being written out. <a href="#a9dbcf38438186863844ef44a2226ee0a">More...</a><br/></td></tr>
|
|
<tr class="separator:a9dbcf38438186863844ef44a2226ee0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c5c80c94619eda2488686c937413956"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMLSSerializerFilter.html">DOMLSSerializerFilter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a5c5c80c94619eda2488686c937413956">getFilter</a> () const =0</td></tr>
|
|
<tr class="memdesc:a5c5c80c94619eda2488686c937413956"><td class="mdescLeft"> </td><td class="mdescRight">Return the WriterFilter used. <a href="#a5c5c80c94619eda2488686c937413956">More...</a><br/></td></tr>
|
|
<tr class="separator:a5c5c80c94619eda2488686c937413956"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8209d55732aa29c827512856bf51464a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a8209d55732aa29c827512856bf51464a">write</a> (const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *nodeToWrite, <a class="el" href="classxercesc_1_1DOMLSOutput.html">DOMLSOutput</a> *const destination)=0</td></tr>
|
|
<tr class="memdesc:a8209d55732aa29c827512856bf51464a"><td class="mdescLeft"> </td><td class="mdescRight">Write out the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a></code>. <a href="#a8209d55732aa29c827512856bf51464a">More...</a><br/></td></tr>
|
|
<tr class="separator:a8209d55732aa29c827512856bf51464a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2b04937851b70f60cef6c1f3a914ed8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#ac2b04937851b70f60cef6c1f3a914ed8">writeToURI</a> (const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *nodeToWrite, const XMLCh *uri)=0</td></tr>
|
|
<tr class="memdesc:ac2b04937851b70f60cef6c1f3a914ed8"><td class="mdescLeft"> </td><td class="mdescRight">Write out the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a></code>. <a href="#ac2b04937851b70f60cef6c1f3a914ed8">More...</a><br/></td></tr>
|
|
<tr class="separator:ac2b04937851b70f60cef6c1f3a914ed8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83d7c62ee96523dbcd79011860ffc555"><td class="memItemLeft" align="right" valign="top">virtual XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a83d7c62ee96523dbcd79011860ffc555">writeToString</a> (const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *nodeToWrite, <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *manager=NULL)=0</td></tr>
|
|
<tr class="memdesc:a83d7c62ee96523dbcd79011860ffc555"><td class="mdescLeft"> </td><td class="mdescRight">Serialize the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a></code>. <a href="#a83d7c62ee96523dbcd79011860ffc555">More...</a><br/></td></tr>
|
|
<tr class="separator:a83d7c62ee96523dbcd79011860ffc555"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
|
|
<tr class="memitem:afdf76237beed6293737f3aebf5f8f749"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#afdf76237beed6293737f3aebf5f8f749">release</a> ()=0</td></tr>
|
|
<tr class="memdesc:afdf76237beed6293737f3aebf5f8f749"><td class="mdescLeft"> </td><td class="mdescRight">Called to indicate that this Writer is no longer in use and that the implementation may relinquish any resources associated with it. <a href="#afdf76237beed6293737f3aebf5f8f749">More...</a><br/></td></tr>
|
|
<tr class="separator:afdf76237beed6293737f3aebf5f8f749"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
|
|
<tr class="memitem:ad324995e2823d0ca435afebd0172dae4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMLSSerializer.html#ad324995e2823d0ca435afebd0172dae4">DOMLSSerializer</a> ()</td></tr>
|
|
<tr class="separator:ad324995e2823d0ca435afebd0172dae4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ad324995e2823d0ca435afebd0172dae4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::DOMLSSerializer::DOMLSSerializer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0f0b5bd3fed8a345e5be489ac8d21a01"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::DOMLSSerializer::~DOMLSSerializer </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="aaf0e8286a9f19e459bc1ea4c5ab2c49a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMConfiguration.html">DOMConfiguration</a>* xercesc::DOMLSSerializer::getDomConfig </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The <a class="el" href="classxercesc_1_1DOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a> object used by the LSSerializer when serializing a DOM node. </p>
|
|
<p>In addition to the parameters recognized in on the <code><a class="el" href="classxercesc_1_1DOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a></code> interface defined in [DOM Level 3 Core], the <code><a class="el" href="classxercesc_1_1DOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a></code> objects for <code><a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a></code> add or modify the following parameters:</p>
|
|
<p>"canonical-form" true [optional] Writes the document according to the rules specified in [Canonical XML]. In addition to the behavior described in "canonical-form" [DOM Level 3 Core], setting this parameter to true will set the parameters "format-pretty-print", "discard-default-content", and "xml-declaration", to false. Setting one of those parameters to true will set this parameter to false. Serializing an XML 1.1 document when "canonical-form" is true will generate a fatal error. false [required] (default) Do not canonicalize the output.</p>
|
|
<p>"discard-default-content" true [required] (default) Use the <a class="el" href="classxercesc_1_1DOMAttr.html#ac2c2e4b40e9d9d94f5264794aa140490" title="Returns true if the attribute received its value explicitly in the XML document, or if a value was as...">DOMAttr::getSpecified</a> attribute to decide what attributes should be discarded. Note that some implementations might use whatever information available to the implementation (i.e. XML schema, DTD, the <a class="el" href="classxercesc_1_1DOMAttr.html#ac2c2e4b40e9d9d94f5264794aa140490" title="Returns true if the attribute received its value explicitly in the XML document, or if a value was as...">DOMAttr::getSpecified</a> attribute, and so on) to determine what attributes and content to discard if this parameter is set to true. false [required] Keep all attributes and all content.</p>
|
|
<p>"format-pretty-print" true [optional] Formatting the output by adding whitespace to produce a pretty-printed, indented, human-readable form. The exact form of the transformations is not specified by this specification. Pretty-printing changes the content of the document and may affect the validity of the document, validating implementations should preserve validity. false [required] (default) Don't pretty-print the result.</p>
|
|
<p>"ignore-unknown-character-denormalizations" true [required] (default) If, while verifying full normalization when [XML 1.1] is supported, a character is encountered for which the normalization properties cannot be determined, then raise a "unknown-character-denormalization" warning (instead of raising an error, if this parameter is not set) and ignore any possible denormalizations caused by these characters. false [optional] Report a fatal error if a character is encountered for which the processor cannot determine the normalization properties.</p>
|
|
<p>"normalize-characters" This parameter is equivalent to the one defined by <code><a class="el" href="classxercesc_1_1DOMConfiguration.html" title="The DOMConfiguration interface represents the configuration of a document and maintains a table of re...">DOMConfiguration</a></code> in [DOM Level 3 Core]. Unlike in the Core, the default value for this parameter is true. While DOM implementations are not required to support fully normalizing the characters in the document according to appendix E of [XML 1.1], this parameter must be activated by default if supported.</p>
|
|
<p>"xml-declaration" true [required] (default) If a <a class="el" href="classxercesc_1_1DOMDocument.html" title="The DOMDocument interface represents the entire XML document. ">DOMDocument</a>, <a class="el" href="classxercesc_1_1DOMElement.html" title="By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...">DOMElement</a>, or <a class="el" href="classxercesc_1_1DOMEntity.html" title="This interface represents an entity, either parsed or unparsed, in an XML document. ">DOMEntity</a> node is serialized, the XML declaration, or text declaration, should be included. The version (DOMDocument::xmlVersion if the document is a Level 3 document and the version is non-null, otherwise use the value "1.0"), and the output encoding (see <a class="el" href="classxercesc_1_1DOMLSSerializer.html#a8209d55732aa29c827512856bf51464a" title="Write out the specified node as described above in the description of DOMLSSerializer. ">DOMLSSerializer::write</a> for details on how to find the output encoding) are specified in the serialized XML declaration. false [required] Do not serialize the XML and text declarations. Report a "xml-declaration-needed" warning if this will cause problems (i.e. the serialized data is of an XML version other than [XML 1.0], or an encoding would be needed to be able to re-parse the serialized data).</p>
|
|
<p>"error-handler" Contains a <a class="el" href="classxercesc_1_1DOMErrorHandler.html" title="Basic interface for DOM error handlers. ">DOMErrorHandler</a> object. If an error is encountered in the document, the implementation will call back the <a class="el" href="classxercesc_1_1DOMErrorHandler.html" title="Basic interface for DOM error handlers. ">DOMErrorHandler</a> registered using this parameter. The implementation may provide a default <a class="el" href="classxercesc_1_1DOMErrorHandler.html" title="Basic interface for DOM error handlers. ">DOMErrorHandler</a> object. When called, DOMError::relatedData will contain the closest node to where the error occurred. If the implementation is unable to determine the node where the error occurs, DOMError::relatedData will contain the <a class="el" href="classxercesc_1_1DOMDocument.html" title="The DOMDocument interface represents the entire XML document. ">DOMDocument</a> node. Mutations to the document from within an error handler will result in implementation dependent behavior.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The pointer to the configuration object. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5c5c80c94619eda2488686c937413956"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMLSSerializerFilter.html">DOMLSSerializerFilter</a>* xercesc::DOMLSSerializer::getFilter </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the WriterFilter used. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The writer filter used. </dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classxercesc_1_1DOMLSSerializer.html#ad984a18ce922002cc6d9be54cb2de7ae" title="When the application provides a filter, the serializer will call out to the filter before serializing...">setFilter</a> </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9dbcf38438186863844ef44a2226ee0a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const XMLCh* xercesc::DOMLSSerializer::getNewLine </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the end-of-line sequence of characters to be used in the XML being written out. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The end-of-line sequence of characters to be used. </dd></dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a43effa49c56258bd51ac7fddea8245c1" title="The end-of-line sequence of characters to be used in the XML being written out. ">setNewLine</a> </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afdf76237beed6293737f3aebf5f8f749"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMLSSerializer::release </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Called to indicate that this Writer is no longer in use and that the implementation may relinquish any resources associated with it. </p>
|
|
<p>Access to a released object will lead to unexpected result. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad984a18ce922002cc6d9be54cb2de7ae"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMLSSerializer::setFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMLSSerializerFilter.html">DOMLSSerializerFilter</a> * </td>
|
|
<td class="paramname"><em>filter</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>When the application provides a filter, the serializer will call out to the filter before serializing each Node. </p>
|
|
<p>Attribute nodes are never passed to the filter. The filter implementation can choose to remove the node from the stream or to terminate the serialization early.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filter</td><td>The writer filter to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a5c5c80c94619eda2488686c937413956" title="Return the WriterFilter used. ">getFilter</a> </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a43effa49c56258bd51ac7fddea8245c1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::DOMLSSerializer::setNewLine </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const XMLCh *const </td>
|
|
<td class="paramname"><em>newLine</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The end-of-line sequence of characters to be used in the XML being written out. </p>
|
|
<p>The only permitted values are these: </p>
|
|
<dl>
|
|
<dt><code>null</code> </dt>
|
|
<dd>Use a default end-of-line sequence. DOM implementations should choose the default to match the usual convention for text files in the environment being used. Implementations must choose a default sequence that matches one of those allowed by 2.11 "End-of-Line
|
|
Handling". However, Xerces-C++ always uses LF when this property is set to <code>null</code> since otherwise automatic translation of LF to CR-LF on Windows for text files would result in such files containing CR-CR-LF. If you need Windows-style end of line sequences in your output, consider writing to a file opened in text mode or explicitly set this property to CR-LF. </dd>
|
|
<dt>CR </dt>
|
|
<dd>The carriage-return character (#xD). </dd>
|
|
<dt>CR-LF </dt>
|
|
<dd>The carriage-return and line-feed characters (#xD #xA). </dd>
|
|
<dt>LF </dt>
|
|
<dd>The line-feed character (#xA). </dd>
|
|
</dl>
|
|
<p><br/>
|
|
The default value for this attribute is <code>null</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">newLine</td><td>The end-of-line sequence of characters to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classxercesc_1_1DOMLSSerializer.html#a9dbcf38438186863844ef44a2226ee0a" title="Return the end-of-line sequence of characters to be used in the XML being written out...">getNewLine</a> </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8209d55732aa29c827512856bf51464a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool xercesc::DOMLSSerializer::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> * </td>
|
|
<td class="paramname"><em>nodeToWrite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMLSOutput.html">DOMLSOutput</a> *const </td>
|
|
<td class="paramname"><em>destination</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write out the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a></code>. </p>
|
|
<p>Writing a Document or Entity node produces a serialized form that is well formed XML. Writing other node types produces a fragment of text in a form that is not fully defined by this document, but that should be useful to a human for debugging or diagnostic purposes.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nodeToWrite</td><td>The <code>Document</code> or <code>Entity</code> node to be written. For other node types, something sensible should be written, but the exact serialized form is not specified. </td></tr>
|
|
<tr><td class="paramname">destination</td><td>The destination for the data to be written. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns <code>true</code> if <code>node</code> was successfully serialized and <code>false</code> in case a failure occured and the failure wasn't canceled by the error handler. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a83d7c62ee96523dbcd79011860ffc555"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual XMLCh* xercesc::DOMLSSerializer::writeToString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> * </td>
|
|
<td class="paramname"><em>nodeToWrite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> * </td>
|
|
<td class="paramname"><em>manager</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Serialize the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a></code>. </p>
|
|
<p>The result of serializing the node is returned as a string. Writing a Document or Entity node produces a serialized form that is well formed XML. Writing other node types produces a fragment of text in a form that is not fully defined by this document, but that should be useful to a human for debugging or diagnostic purposes.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nodeToWrite</td><td>The node to be written. </td></tr>
|
|
<tr><td class="paramname">manager</td><td>The memory manager to be used to allocate the result string. If NULL is used, the memory manager used to construct the serializer will be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the serialized data, or <code>null</code> in case a failure occured and the failure wasn't canceled by the error handler. The returned string is always in UTF-16. The encoding information available in <a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a> is ignored in <a class="el" href="classxercesc_1_1DOMLSSerializer.html#a83d7c62ee96523dbcd79011860ffc555" title="Serialize the specified node as described above in the description of DOMLSSerializer. ">writeToString()</a>. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac2b04937851b70f60cef6c1f3a914ed8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool xercesc::DOMLSSerializer::writeToURI </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> * </td>
|
|
<td class="paramname"><em>nodeToWrite</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const XMLCh * </td>
|
|
<td class="paramname"><em>uri</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write out the specified node as described above in the description of <code><a class="el" href="classxercesc_1_1DOMLSSerializer.html">DOMLSSerializer</a></code>. </p>
|
|
<p>Writing a Document or Entity node produces a serialized form that is well formed XML. Writing other node types produces a fragment of text in a form that is not fully defined by this document, but that should be useful to a human for debugging or diagnostic purposes.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nodeToWrite</td><td>The <code>Document</code> or <code>Entity</code> node to be written. For other node types, something sensible should be written, but the exact serialized form is not specified. </td></tr>
|
|
<tr><td class="paramname">uri</td><td>The destination for the data to be written. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns <code>true</code> if <code>node</code> was successfully serialized and <code>false</code> in case a failure occured and the failure wasn't canceled by the error handler. </dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="DOMLSSerializer_8hpp_source.html">DOMLSSerializer.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|