source: NonGTP/Xerces/xerces/doc/html/apiDocs/classXMLTranscoder.html @ 358

Revision 358, 32.4 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>XMLTranscoder class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<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>
44<hr><h1>XMLTranscoder Class Reference</h1><code>XMLTranscoder</code> is for transcoding non-local code page encodings, i.e.
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for XMLTranscoder:<p><center><img src="classXMLTranscoder__inherit__graph.gif" border="0" usemap="#XMLTranscoder__inherit__map" alt="Inheritance graph"></center>
48<map name="XMLTranscoder__inherit__map">
49<area href="classXMemory.html" shape="rect" coords="25,36,95,17" alt="">
50</map>
51<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XMLTranscoder:<p><center><img src="classXMLTranscoder__coll__graph.gif" border="0" usemap="#XMLTranscoder__coll__map" alt="Collaboration graph"></center>
52<map name="XMLTranscoder__coll__map">
53<area href="classXMemory.html" shape="rect" coords="7,36,76,17" alt="">
54<area href="classMemoryManager.html" shape="rect" coords="100,36,209,17" alt="">
55</map>
56<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXMLTranscoder-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
57<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
58<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#s2">UnRepOpts</a> { <a class="el" href="classXMLTranscoder.html#s2s0">UnRep_Throw</a>,
59<a class="el" href="classXMLTranscoder.html#s2s1">UnRep_RepChar</a>
60 }</td></tr>
61<tr><td>&nbsp;</td><td><font size=-1><em>This enum is used by the <code><a class="el" href="classXMLTranscoder.html#z504_1">transcodeTo</a>()</code> method to indicate how to react to unrepresentable characters.</em> <a href="#s2">More...</a><em></em></font><br><br></td></tr>
62<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
63<tr><td colspan="2"><div class="groupHeader">Destructor.</div></td></tr>
64<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#z503_0">~XMLTranscoder</a> ()</td></tr>
65<tr><td>&nbsp;</td><td><font size=-1><em>Destructor for XMLTranscoder.</em> <a href="#z503_0">More...</a><em></em></font><br><br></td></tr>
66<tr><td colspan="2"><div class="groupHeader">The virtual transcoding interface</div></td></tr>
67<tr><td nowrap align=right valign=top>virtual unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#z504_0">transcodeFrom</a> (const <a class="el" href="XercesDefs_8hpp.html#a16">XMLByte</a> *const srcData, const unsigned int srcCount, XMLCh *const toFill, const unsigned int maxChars, unsigned int &amp;bytesEaten, unsigned char *const charSizes)=0</td></tr>
68<tr><td>&nbsp;</td><td><font size=-1><em>Converts from the encoding of the service to the internal XMLCh* encoding.</em> <a href="#z504_0">More...</a><em></em></font><br><br></td></tr>
69<tr><td nowrap align=right valign=top>virtual unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#z504_1">transcodeTo</a> (const XMLCh *const srcData, const unsigned int srcCount, <a class="el" href="XercesDefs_8hpp.html#a16">XMLByte</a> *const toFill, const unsigned int maxBytes, unsigned int &amp;charsEaten, const <a class="el" href="classXMLTranscoder.html#s2">UnRepOpts</a> options)=0</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>Converts from the internal XMLCh* encoding to the encoding of the service.</em> <a href="#z504_1">More...</a><em></em></font><br><br></td></tr>
71<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#z504_2">canTranscodeTo</a> (const unsigned int toCheck) const=0</td></tr>
72<tr><td>&nbsp;</td><td><font size=-1><em>Query whether the transcoder can handle a given character.</em> <a href="#z504_2">More...</a><em></em></font><br><br></td></tr>
73<tr><td colspan="2"><div class="groupHeader">Getter methods</div></td></tr>
74<tr><td nowrap align=right valign=top>unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#z505_0">getBlockSize</a> () const</td></tr>
75<tr><td>&nbsp;</td><td><font size=-1><em>Get the internal block size.</em> <a href="#z505_0">More...</a><em></em></font><br><br></td></tr>
76<tr><td nowrap align=right valign=top>const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#z505_1">getEncodingName</a> () const</td></tr>
77<tr><td>&nbsp;</td><td><font size=-1><em>Get the encoding name.</em> <a href="#z505_1">More...</a><em></em></font><br><br></td></tr>
78<tr><td colspan="2"><div class="groupHeader">Getter methods</div></td></tr>
79<tr><td nowrap align=right valign=top><a class="el" href="classMemoryManager.html">MemoryManager</a> *&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#z506_0">getMemoryManager</a> () const</td></tr>
80<tr><td>&nbsp;</td><td><font size=-1><em>Get the plugged-in memory manager.</em> <a href="#z506_0">More...</a><em></em></font><br><br></td></tr>
81<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
82<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#b0">XMLTranscoder</a> (const XMLCh *const encodingName, const unsigned int blockSize, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
83<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classXMLTranscoder.html#b1">checkBlockSize</a> (const unsigned int toCheck)</td></tr>
84</table>
85<hr><a name="_details"></a><h2>Detailed Description</h2>
86<code>XMLTranscoder</code> is for transcoding non-local code page encodings, i.e.
87<p>
88named encodings. These are used internally by the scanner to internalize raw XML into the internal Unicode format, and by writer classes to convert that internal Unicode format (which comes out of the parser) back out to a format that the receiving client code wants to use.
89<p>
90<hr><h2>Member Enumeration Documentation</h2>
91<a name="s2" doxytag="XMLTranscoder::UnRepOpts"></a><p>
92<table width="100%" cellpadding="2" cellspacing="0" border="0">
93  <tr>
94    <td class="md">
95      <table cellpadding="0" cellspacing="0" border="0">
96        <tr>
97          <td class="md" nowrap valign="top"> enum XMLTranscoder::UnRepOpts
98      </table>
99    </td>
100  </tr>
101</table>
102<table cellspacing=5 cellpadding=0 border=0>
103  <tr>
104    <td>
105      &nbsp;
106    </td>
107    <td>
108
109<p>
110This enum is used by the <code><a class="el" href="classXMLTranscoder.html#z504_1">transcodeTo</a>()</code> method to indicate how to react to unrepresentable characters.
111<p>
112The <code><a class="el" href="classXMLTranscoder.html#z504_0">transcodeFrom</a>()</code> method always works the same. It will consider any invalid data to be an error and throw. <dl compact><dt><b>
113Enumeration values:</b><dd>
114<table border=0 cellspacing=2 cellpadding=0>
115<tr><td valign=top><em><a name="s2s0" doxytag="UnRep_Throw"></a><em>UnRep_Throw</em></em>&nbsp;</td><td>
116Throw an exception.</td></tr>
117<tr><td valign=top><em><a name="s2s1" doxytag="UnRep_RepChar"></a><em>UnRep_RepChar</em></em>&nbsp;</td><td>
118Use the replacement char.</td></tr>
119</table>
120</dl>
121    </td>
122  </tr>
123</table>
124<hr><h2>Constructor &amp; Destructor Documentation</h2>
125<a name="z503_0" doxytag="XMLTranscoder::~XMLTranscoder"></a><p>
126<table width="100%" cellpadding="2" cellspacing="0" border="0">
127  <tr>
128    <td class="md">
129      <table cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td class="md" nowrap valign="top"> virtual XMLTranscoder::~XMLTranscoder </td>
132          <td class="md" valign="top">(&nbsp;</td>
133          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
134          <td class="md" valign="top">)&nbsp;</td>
135          <td class="md" nowrap><code> [virtual]</code></td>
136        </tr>
137
138      </table>
139    </td>
140  </tr>
141</table>
142<table cellspacing=5 cellpadding=0 border=0>
143  <tr>
144    <td>
145      &nbsp;
146    </td>
147    <td>
148
149<p>
150Destructor for XMLTranscoder.
151<p>
152    </td>
153  </tr>
154</table>
155<a name="b0" doxytag="XMLTranscoder::XMLTranscoder"></a><p>
156<table width="100%" cellpadding="2" cellspacing="0" border="0">
157  <tr>
158    <td class="md">
159      <table cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td class="md" nowrap valign="top"> XMLTranscoder::XMLTranscoder </td>
162          <td class="md" valign="top">(&nbsp;</td>
163          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
164          <td class="mdname" nowrap>&nbsp; <em>encodingName</em>, </td>
165        </tr>
166        <tr>
167          <td></td>
168          <td></td>
169          <td class="md" nowrap>const unsigned int&nbsp;</td>
170          <td class="mdname" nowrap>&nbsp; <em>blockSize</em>, </td>
171        </tr>
172        <tr>
173          <td></td>
174          <td></td>
175          <td class="md" nowrap><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td>
176          <td class="mdname" nowrap>&nbsp; <em>manager</em> = <a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a></td>
177        </tr>
178        <tr>
179          <td></td>
180          <td class="md">)&nbsp;</td>
181          <td class="md" colspan="2"><code> [protected]</code></td>
182        </tr>
183
184      </table>
185    </td>
186  </tr>
187</table>
188<table cellspacing=5 cellpadding=0 border=0>
189  <tr>
190    <td>
191      &nbsp;
192    </td>
193    <td>
194
195<p>
196    </td>
197  </tr>
198</table>
199<hr><h2>Member Function Documentation</h2>
200<a name="z504_2" doxytag="XMLTranscoder::canTranscodeTo"></a><p>
201<table width="100%" cellpadding="2" cellspacing="0" border="0">
202  <tr>
203    <td class="md">
204      <table cellpadding="0" cellspacing="0" border="0">
205        <tr>
206          <td class="md" nowrap valign="top"> virtual bool XMLTranscoder::canTranscodeTo </td>
207          <td class="md" valign="top">(&nbsp;</td>
208          <td class="md" nowrap valign="top">const unsigned int&nbsp;</td>
209          <td class="mdname1" valign="top" nowrap>&nbsp; <em>toCheck</em>          </td>
210          <td class="md" valign="top">)&nbsp;</td>
211          <td class="md" nowrap> const<code> [pure virtual]</code></td>
212        </tr>
213
214      </table>
215    </td>
216  </tr>
217</table>
218<table cellspacing=5 cellpadding=0 border=0>
219  <tr>
220    <td>
221      &nbsp;
222    </td>
223    <td>
224
225<p>
226Query whether the transcoder can handle a given character.
227<p>
228<dl compact><dt><b>
229Parameters: </b><dd>
230<table border=0 cellspacing=2 cellpadding=0>
231<tr><td valign=top><em>toCheck</em>&nbsp;</td><td>
232the character code point to check </td></tr>
233</table>
234</dl>    </td>
235  </tr>
236</table>
237<a name="b1" doxytag="XMLTranscoder::checkBlockSize"></a><p>
238<table width="100%" cellpadding="2" cellspacing="0" border="0">
239  <tr>
240    <td class="md">
241      <table cellpadding="0" cellspacing="0" border="0">
242        <tr>
243          <td class="md" nowrap valign="top"> void XMLTranscoder::checkBlockSize </td>
244          <td class="md" valign="top">(&nbsp;</td>
245          <td class="md" nowrap valign="top">const unsigned int&nbsp;</td>
246          <td class="mdname1" valign="top" nowrap>&nbsp; <em>toCheck</em>          </td>
247          <td class="md" valign="top">)&nbsp;</td>
248          <td class="md" nowrap><code> [protected]</code></td>
249        </tr>
250
251      </table>
252    </td>
253  </tr>
254</table>
255<table cellspacing=5 cellpadding=0 border=0>
256  <tr>
257    <td>
258      &nbsp;
259    </td>
260    <td>
261
262<p>
263    </td>
264  </tr>
265</table>
266<a name="z505_0" doxytag="XMLTranscoder::getBlockSize"></a><p>
267<table width="100%" cellpadding="2" cellspacing="0" border="0">
268  <tr>
269    <td class="md">
270      <table cellpadding="0" cellspacing="0" border="0">
271        <tr>
272          <td class="md" nowrap valign="top"> unsigned int XMLTranscoder::getBlockSize </td>
273          <td class="md" valign="top">(&nbsp;</td>
274          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
275          <td class="md" valign="top">)&nbsp;</td>
276          <td class="md" nowrap> const</td>
277        </tr>
278
279      </table>
280    </td>
281  </tr>
282</table>
283<table cellspacing=5 cellpadding=0 border=0>
284  <tr>
285    <td>
286      &nbsp;
287    </td>
288    <td>
289
290<p>
291Get the internal block size.
292<p>
293<dl compact><dt><b>
294Returns: </b><dd>
295The block size indicated in the constructor. </dl>    </td>
296  </tr>
297</table>
298<a name="z505_1" doxytag="XMLTranscoder::getEncodingName"></a><p>
299<table width="100%" cellpadding="2" cellspacing="0" border="0">
300  <tr>
301    <td class="md">
302      <table cellpadding="0" cellspacing="0" border="0">
303        <tr>
304          <td class="md" nowrap valign="top"> const XMLCh * XMLTranscoder::getEncodingName </td>
305          <td class="md" valign="top">(&nbsp;</td>
306          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
307          <td class="md" valign="top">)&nbsp;</td>
308          <td class="md" nowrap> const</td>
309        </tr>
310
311      </table>
312    </td>
313  </tr>
314</table>
315<table cellspacing=5 cellpadding=0 border=0>
316  <tr>
317    <td>
318      &nbsp;
319    </td>
320    <td>
321
322<p>
323Get the encoding name.
324<p>
325<dl compact><dt><b>
326Returns: </b><dd>
327the name of the encoding that this <code>XMLTranscoder</code> object is for </dl>    </td>
328  </tr>
329</table>
330<a name="z506_0" doxytag="XMLTranscoder::getMemoryManager"></a><p>
331<table width="100%" cellpadding="2" cellspacing="0" border="0">
332  <tr>
333    <td class="md">
334      <table cellpadding="0" cellspacing="0" border="0">
335        <tr>
336          <td class="md" nowrap valign="top"> <a class="el" href="classMemoryManager.html">MemoryManager</a> * XMLTranscoder::getMemoryManager </td>
337          <td class="md" valign="top">(&nbsp;</td>
338          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
339          <td class="md" valign="top">)&nbsp;</td>
340          <td class="md" nowrap> const</td>
341        </tr>
342
343      </table>
344    </td>
345  </tr>
346</table>
347<table cellspacing=5 cellpadding=0 border=0>
348  <tr>
349    <td>
350      &nbsp;
351    </td>
352    <td>
353
354<p>
355Get the plugged-in memory manager.
356<p>
357This method returns the plugged-in memory manager user for dynamic memory allocation/deallocation.
358<p>
359<dl compact><dt><b>
360Returns: </b><dd>
361the plugged-in memory manager </dl>    </td>
362  </tr>
363</table>
364<a name="z504_0" doxytag="XMLTranscoder::transcodeFrom"></a><p>
365<table width="100%" cellpadding="2" cellspacing="0" border="0">
366  <tr>
367    <td class="md">
368      <table cellpadding="0" cellspacing="0" border="0">
369        <tr>
370          <td class="md" nowrap valign="top"> virtual unsigned int XMLTranscoder::transcodeFrom </td>
371          <td class="md" valign="top">(&nbsp;</td>
372          <td class="md" nowrap valign="top">const <a class="el" href="XercesDefs_8hpp.html#a16">XMLByte</a> *const&nbsp;</td>
373          <td class="mdname" nowrap>&nbsp; <em>srcData</em>, </td>
374        </tr>
375        <tr>
376          <td></td>
377          <td></td>
378          <td class="md" nowrap>const unsigned int&nbsp;</td>
379          <td class="mdname" nowrap>&nbsp; <em>srcCount</em>, </td>
380        </tr>
381        <tr>
382          <td></td>
383          <td></td>
384          <td class="md" nowrap>XMLCh *const&nbsp;</td>
385          <td class="mdname" nowrap>&nbsp; <em>toFill</em>, </td>
386        </tr>
387        <tr>
388          <td></td>
389          <td></td>
390          <td class="md" nowrap>const unsigned int&nbsp;</td>
391          <td class="mdname" nowrap>&nbsp; <em>maxChars</em>, </td>
392        </tr>
393        <tr>
394          <td></td>
395          <td></td>
396          <td class="md" nowrap>unsigned int &amp;&nbsp;</td>
397          <td class="mdname" nowrap>&nbsp; <em>bytesEaten</em>, </td>
398        </tr>
399        <tr>
400          <td></td>
401          <td></td>
402          <td class="md" nowrap>unsigned char *const&nbsp;</td>
403          <td class="mdname" nowrap>&nbsp; <em>charSizes</em></td>
404        </tr>
405        <tr>
406          <td></td>
407          <td class="md">)&nbsp;</td>
408          <td class="md" colspan="2"><code> [pure virtual]</code></td>
409        </tr>
410
411      </table>
412    </td>
413  </tr>
414</table>
415<table cellspacing=5 cellpadding=0 border=0>
416  <tr>
417    <td>
418      &nbsp;
419    </td>
420    <td>
421
422<p>
423Converts from the encoding of the service to the internal XMLCh* encoding.
424<p>
425<dl compact><dt><b>
426Parameters: </b><dd>
427<table border=0 cellspacing=2 cellpadding=0>
428<tr><td valign=top><em>srcData</em>&nbsp;</td><td>
429the source buffer to be transcoded </td></tr>
430<tr><td valign=top><em>srcCount</em>&nbsp;</td><td>
431number of bytes in the source buffer </td></tr>
432<tr><td valign=top><em>toFill</em>&nbsp;</td><td>
433the destination buffer </td></tr>
434<tr><td valign=top><em>maxChars</em>&nbsp;</td><td>
435the max number of characters in the destination buffer </td></tr>
436<tr><td valign=top><em>bytesEaten</em>&nbsp;</td><td>
437after transcoding, this will hold the number of bytes that were processed from the source buffer </td></tr>
438<tr><td valign=top><em>charSizes</em>&nbsp;</td><td>
439an array which must be at least as big as maxChars into which will be inserted values that indicate how many bytes from the input went into each XMLCh that was created into toFill. Since many encodings use variable numbers of byte per character, this provides a means to find out what bytes in the input went into making a particular output UTF-16 character. </td></tr>
440</table>
441</dl><dl compact><dt><b>
442Returns: </b><dd>
443Returns the number of chars put into the target buffer </dl>    </td>
444  </tr>
445</table>
446<a name="z504_1" doxytag="XMLTranscoder::transcodeTo"></a><p>
447<table width="100%" cellpadding="2" cellspacing="0" border="0">
448  <tr>
449    <td class="md">
450      <table cellpadding="0" cellspacing="0" border="0">
451        <tr>
452          <td class="md" nowrap valign="top"> virtual unsigned int XMLTranscoder::transcodeTo </td>
453          <td class="md" valign="top">(&nbsp;</td>
454          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
455          <td class="mdname" nowrap>&nbsp; <em>srcData</em>, </td>
456        </tr>
457        <tr>
458          <td></td>
459          <td></td>
460          <td class="md" nowrap>const unsigned int&nbsp;</td>
461          <td class="mdname" nowrap>&nbsp; <em>srcCount</em>, </td>
462        </tr>
463        <tr>
464          <td></td>
465          <td></td>
466          <td class="md" nowrap><a class="el" href="XercesDefs_8hpp.html#a16">XMLByte</a> *const&nbsp;</td>
467          <td class="mdname" nowrap>&nbsp; <em>toFill</em>, </td>
468        </tr>
469        <tr>
470          <td></td>
471          <td></td>
472          <td class="md" nowrap>const unsigned int&nbsp;</td>
473          <td class="mdname" nowrap>&nbsp; <em>maxBytes</em>, </td>
474        </tr>
475        <tr>
476          <td></td>
477          <td></td>
478          <td class="md" nowrap>unsigned int &amp;&nbsp;</td>
479          <td class="mdname" nowrap>&nbsp; <em>charsEaten</em>, </td>
480        </tr>
481        <tr>
482          <td></td>
483          <td></td>
484          <td class="md" nowrap>const <a class="el" href="classXMLTranscoder.html#s2">UnRepOpts</a>&nbsp;</td>
485          <td class="mdname" nowrap>&nbsp; <em>options</em></td>
486        </tr>
487        <tr>
488          <td></td>
489          <td class="md">)&nbsp;</td>
490          <td class="md" colspan="2"><code> [pure virtual]</code></td>
491        </tr>
492
493      </table>
494    </td>
495  </tr>
496</table>
497<table cellspacing=5 cellpadding=0 border=0>
498  <tr>
499    <td>
500      &nbsp;
501    </td>
502    <td>
503
504<p>
505Converts from the internal XMLCh* encoding to the encoding of the service.
506<p>
507<dl compact><dt><b>
508Parameters: </b><dd>
509<table border=0 cellspacing=2 cellpadding=0>
510<tr><td valign=top><em>srcData</em>&nbsp;</td><td>
511the source buffer to be transcoded </td></tr>
512<tr><td valign=top><em>srcCount</em>&nbsp;</td><td>
513number of characters in the source buffer </td></tr>
514<tr><td valign=top><em>toFill</em>&nbsp;</td><td>
515the destination buffer </td></tr>
516<tr><td valign=top><em>maxBytes</em>&nbsp;</td><td>
517the max number of bytes in the destination buffer </td></tr>
518<tr><td valign=top><em>charsEaten</em>&nbsp;</td><td>
519after transcoding, this will hold the number of chars that were processed from the source buffer </td></tr>
520<tr><td valign=top><em>options</em>&nbsp;</td><td>
521options to pass to the transcoder that explain how to respond to an unrepresentable character </td></tr>
522</table>
523</dl><dl compact><dt><b>
524Returns: </b><dd>
525Returns the number of chars put into the target buffer </dl>    </td>
526  </tr>
527</table>
528<hr>The documentation for this class was generated from the following file:<ul>
529<li><a class="el" href="TransService_8hpp-source.html">TransService.hpp</a></ul>
530    </FONT></TD></TR></TABLE><BR>
531</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
532              Copyright &copy; 1994-2004 The Apache Software Foundation.
533              All Rights Reserved.
534            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.