blob: 6d3ed73bc7c77e0af0f60feda992c761e10aa737 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>XalanUTF16Transcoder Class Reference</h1><code>#include &lt;<a class="el" href="XalanUTF16Transcoder_8hpp-source.html">XalanUTF16Transcoder.hpp</a>&gt;</code>
<p>
Inheritance diagram for XalanUTF16Transcoder:<p><center><img src="classXalanUTF16Transcoder__inherit__graph.gif" border="0" usemap="#XalanUTF16Transcoder_inherit_map" alt="Inheritance graph"></center>
<map name="XalanUTF16Transcoder_inherit_map">
<area href="classXalanOutputTranscoder.html" shape="rect" coords="6,42,164,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XalanUTF16Transcoder:<p><center><img src="classXalanUTF16Transcoder__coll__graph.gif" border="0" usemap="#XalanUTF16Transcoder_coll_map" alt="Collaboration graph"></center>
<map name="XalanUTF16Transcoder_coll_map">
<area href="classXalanOutputTranscoder.html" shape="rect" coords="6,42,164,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXalanUTF16Transcoder-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXalanUTF16Transcoder.html#a0">XalanUTF16Transcoder</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<li>virtual <a class="el" href="classXalanUTF16Transcoder.html#a1">~XalanUTF16Transcoder</a> ()
<li>virtual <a class="el" href="classXalanOutputTranscoder.html#s1">eCode</a> <a class="el" href="classXalanUTF16Transcoder.html#a2">transcode</a> (const XalanDOMChar *theSourceData, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> theSourceCount, <a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a> *theTarget, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> theTargetSize, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp;theSourceCharsTranscoded, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp;theTargetBytesUsed)
<dl class="el"><dd><font size=-1><em>Transcode data from UTF-16 to UTF-16.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXalanOutputTranscoder.html#s1">eCode</a> <a class="el" href="classXalanUTF16Transcoder.html#a3">transcode</a> (const <a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a> *theSourceData, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> theSourceCount, XalanDOMChar *theTarget, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> theTargetSize, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp;theSourceCharsTranscoded, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp;theTargetBytesUsed, unsigned char *theCharSizes)
<dl class="el"><dd><font size=-1><em>Transcode data from UTF-16 to UTF-16.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classXalanUTF16Transcoder.html#a4">canTranscodeTo</a> (<a class="el" href="classXalanOutputTranscoder.html#s3">UnicodeCharType</a> theChar) const
</ul>
<h2>Static Public Methods</h2>
<ul>
<li>XalanUTF16Transcoder* <a class="el" href="classXalanUTF16Transcoder.html#d0">create</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
</ul>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XalanUTF16Transcoder::XalanUTF16Transcoder"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XalanUTF16Transcoder::XalanUTF16Transcoder (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;)<code> [explicit]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="XalanUTF16Transcoder::~XalanUTF16Transcoder"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XalanUTF16Transcoder::~XalanUTF16Transcoder (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a4" doxytag="XalanUTF16Transcoder::canTranscodeTo"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool XalanUTF16Transcoder::canTranscodeTo (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanOutputTranscoder.html#s3">UnicodeCharType</a> <em>theChar</em>&nbsp;) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classXalanOutputTranscoder.html#a5">XalanOutputTranscoder</a>. </td>
</tr>
</table>
<a name="d0" doxytag="XalanUTF16Transcoder::create"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XalanUTF16Transcoder * XalanUTF16Transcoder::create (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;)<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="XalanUTF16Transcoder::transcode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXalanOutputTranscoder.html#s1">eCode</a> XalanUTF16Transcoder::transcode (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a> * <em>theSourceData</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> <em>theSourceCount</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
XalanDOMChar * <em>theTarget</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> <em>theTargetSize</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp; <em>theSourceCharsTranscoded</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp; <em>theTargetBytesUsed</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned char * <em>theCharSizes</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Transcode data from UTF-16 to UTF-16.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theSourceData</em>
&nbsp;</td><td>
The source data to transcode </td></tr>
<tr><td valign=top><em>theSourceCount</em>
&nbsp;</td><td>
The length of the source data. </td></tr>
<tr><td valign=top><em>theResult</em>
&nbsp;</td><td>
The error code, if any. </td></tr>
<tr><td valign=top><em>theTarget</em>
&nbsp;</td><td>
The target array for storing the transcoded data. </td></tr>
<tr><td valign=top><em>theTargetSize</em>
&nbsp;</td><td>
The number of characters that can be stored in the target. </td></tr>
<tr><td valign=top><em>theSourceCharsTranscoded</em>
&nbsp;</td><td>
The count of the source characters that were transcoded. </td></tr>
<tr><td valign=top><em>theTargetBytesUsed</em>
&nbsp;</td><td>
The number of characters stored in the target array </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
The result code. </dl>
<p>
Reimplemented from <a class="el" href="classXalanOutputTranscoder.html#a4">XalanOutputTranscoder</a>. </td>
</tr>
</table>
<a name="a2" doxytag="XalanUTF16Transcoder::transcode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXalanOutputTranscoder.html#s1">eCode</a> XalanUTF16Transcoder::transcode (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>theSourceData</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> <em>theSourceCount</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a> * <em>theTarget</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> <em>theTargetSize</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp; <em>theSourceCharsTranscoded</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp; <em>theTargetBytesUsed</em>&nbsp;)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Transcode data from UTF-16 to UTF-16.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theSourceData</em>
&nbsp;</td><td>
The source data to transcode </td></tr>
<tr><td valign=top><em>theSourceCount</em>
&nbsp;</td><td>
The length of the source data. </td></tr>
<tr><td valign=top><em>theResult</em>
&nbsp;</td><td>
The error code, if any. </td></tr>
<tr><td valign=top><em>theTarget</em>
&nbsp;</td><td>
The target array for storing the transcoded data. </td></tr>
<tr><td valign=top><em>theTargetSize</em>
&nbsp;</td><td>
The number of characters that can be stored in the target. </td></tr>
<tr><td valign=top><em>theSourceCharsTranscoded</em>
&nbsp;</td><td>
The count of the source characters that were transcoded. </td></tr>
<tr><td valign=top><em>theTargetBytesUsed</em>
&nbsp;</td><td>
The number of characters stored in the target array </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
The result code. </dl>
<p>
Reimplemented from <a class="el" href="classXalanOutputTranscoder.html#a3">XalanOutputTranscoder</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanUTF16Transcoder_8hpp-source.html">XalanUTF16Transcoder.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>