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

Revision 358, 20.2 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>HexBin 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>HexBin  Class Reference</h1><a href="classHexBin-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
45<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
46<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
47<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classHexBin.html#z484_0">getDataLength</a> (const XMLCh *const hexData)</td></tr>
48<tr><td>&nbsp;</td><td><font size=-1><em>return the length of hexData in terms of HexBinary.</em> <a href="#z484_0">More...</a><em></em></font><br><br></td></tr>
49<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classHexBin.html#z484_1">isArrayByteHex</a> (const XMLCh *const hexData)</td></tr>
50<tr><td>&nbsp;</td><td><font size=-1><em>check an array of data against the Hex table.</em> <a href="#z484_1">More...</a><em></em></font><br><br></td></tr>
51<tr><td nowrap align=right valign=top>XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classHexBin.html#z484_2">getCanonicalRepresentation</a> (const XMLCh *const hexData, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
52<tr><td>&nbsp;</td><td><font size=-1><em>get canonical representation.</em> <a href="#z484_2">More...</a><em></em></font><br><br></td></tr>
53<tr><td nowrap align=right valign=top>XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classHexBin.html#z484_3">decode</a> (const XMLCh *const hexData, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
54<tr><td>&nbsp;</td><td><font size=-1><em>Decodes HexBinary data into XMLCh.</em> <a href="#z484_3">More...</a><em></em></font><br><br></td></tr>
55</table>
56<hr><h2>Member Function Documentation</h2>
57<a name="z484_3" doxytag="HexBin::decode"></a><p>
58<table width="100%" cellpadding="2" cellspacing="0" border="0">
59  <tr>
60    <td class="md">
61      <table cellpadding="0" cellspacing="0" border="0">
62        <tr>
63          <td class="md" nowrap valign="top"> XMLCh* HexBin::decode </td>
64          <td class="md" valign="top">(&nbsp;</td>
65          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
66          <td class="mdname" nowrap>&nbsp; <em>hexData</em>, </td>
67        </tr>
68        <tr>
69          <td></td>
70          <td></td>
71          <td class="md" nowrap><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td>
72          <td class="mdname" nowrap>&nbsp; <em>manager</em> = <a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a></td>
73        </tr>
74        <tr>
75          <td></td>
76          <td class="md">)&nbsp;</td>
77          <td class="md" colspan="2"><code> [static]</code></td>
78        </tr>
79
80      </table>
81    </td>
82  </tr>
83</table>
84<table cellspacing=5 cellpadding=0 border=0>
85  <tr>
86    <td>
87      &nbsp;
88    </td>
89    <td>
90
91<p>
92Decodes HexBinary data into XMLCh.
93<p>
94NOTE: The returned buffer is dynamically allocated and is the responsibility of the caller to delete it when not longer needed. You can call <a class="el" href="classXMLString.html#z522_0">XMLString::release</a> to release this returned buffer.
95<p>
96If a memory manager is provided, ask the memory manager to de-allocate the returned buffer.<dl compact><dt><b>
97Parameters: </b><dd>
98<table border=0 cellspacing=2 cellpadding=0>
99<tr><td valign=top><em>hexData</em>&nbsp;</td><td>
100HexBinary data in XMLCh stream. </td></tr>
101<tr><td valign=top><em>manager</em>&nbsp;</td><td>
102client provided memory manager </td></tr>
103</table>
104</dl><dl compact><dt><b>
105Returns: </b><dd>
106Decoded binary data in XMLCh stream, or NULL if input data can not be decoded. </dl><dl compact><dt><b>
107See also: </b><dd>
108<a class="el" href="classXMLString.html#z522_1">XMLString::release</a>(XMLCh**) </dl>    </td>
109  </tr>
110</table>
111<a name="z484_2" doxytag="HexBin::getCanonicalRepresentation"></a><p>
112<table width="100%" cellpadding="2" cellspacing="0" border="0">
113  <tr>
114    <td class="md">
115      <table cellpadding="0" cellspacing="0" border="0">
116        <tr>
117          <td class="md" nowrap valign="top"> XMLCh* HexBin::getCanonicalRepresentation </td>
118          <td class="md" valign="top">(&nbsp;</td>
119          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
120          <td class="mdname" nowrap>&nbsp; <em>hexData</em>, </td>
121        </tr>
122        <tr>
123          <td></td>
124          <td></td>
125          <td class="md" nowrap><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&nbsp;</td>
126          <td class="mdname" nowrap>&nbsp; <em>manager</em> = <a class="el" href="classXMLPlatformUtils.html#z488_4">XMLPlatformUtils::fgMemoryManager</a></td>
127        </tr>
128        <tr>
129          <td></td>
130          <td class="md">)&nbsp;</td>
131          <td class="md" colspan="2"><code> [static]</code></td>
132        </tr>
133
134      </table>
135    </td>
136  </tr>
137</table>
138<table cellspacing=5 cellpadding=0 border=0>
139  <tr>
140    <td>
141      &nbsp;
142    </td>
143    <td>
144
145<p>
146get canonical representation.
147<p>
148Caller is responsible for the proper deallcation of the string returned.<dl compact><dt><b>
149Parameters: </b><dd>
150<table border=0 cellspacing=2 cellpadding=0>
151<tr><td valign=top><em>hexData</em>&nbsp;</td><td>
152A string containing the HexBinary </td></tr>
153<tr><td valign=top><em>manager</em>&nbsp;</td><td>
154The <a class="el" href="classMemoryManager.html">MemoryManager</a> to use to allocate the string</td></tr>
155</table>
156</dl>return: the canonical representation of the HexBinary if it is a valid HexBinary,  0 otherwise     </td>
157  </tr>
158</table>
159<a name="z484_0" doxytag="HexBin::getDataLength"></a><p>
160<table width="100%" cellpadding="2" cellspacing="0" border="0">
161  <tr>
162    <td class="md">
163      <table cellpadding="0" cellspacing="0" border="0">
164        <tr>
165          <td class="md" nowrap valign="top"> int HexBin::getDataLength </td>
166          <td class="md" valign="top">(&nbsp;</td>
167          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
168          <td class="mdname1" valign="top" nowrap>&nbsp; <em>hexData</em>          </td>
169          <td class="md" valign="top">)&nbsp;</td>
170          <td class="md" nowrap><code> [static]</code></td>
171        </tr>
172
173      </table>
174    </td>
175  </tr>
176</table>
177<table cellspacing=5 cellpadding=0 border=0>
178  <tr>
179    <td>
180      &nbsp;
181    </td>
182    <td>
183
184<p>
185return the length of hexData in terms of HexBinary.
186<p>
187<dl compact><dt><b>
188Parameters: </b><dd>
189<table border=0 cellspacing=2 cellpadding=0>
190<tr><td valign=top><em>hexData</em>&nbsp;</td><td>
191A string containing the HexBinary</td></tr>
192</table>
193</dl>return: -1 if it contains any invalid HexBinary the length of the HexNumber otherwise.     </td>
194  </tr>
195</table>
196<a name="z484_1" doxytag="HexBin::isArrayByteHex"></a><p>
197<table width="100%" cellpadding="2" cellspacing="0" border="0">
198  <tr>
199    <td class="md">
200      <table cellpadding="0" cellspacing="0" border="0">
201        <tr>
202          <td class="md" nowrap valign="top"> bool HexBin::isArrayByteHex </td>
203          <td class="md" valign="top">(&nbsp;</td>
204          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
205          <td class="mdname1" valign="top" nowrap>&nbsp; <em>hexData</em>          </td>
206          <td class="md" valign="top">)&nbsp;</td>
207          <td class="md" nowrap><code> [static]</code></td>
208        </tr>
209
210      </table>
211    </td>
212  </tr>
213</table>
214<table cellspacing=5 cellpadding=0 border=0>
215  <tr>
216    <td>
217      &nbsp;
218    </td>
219    <td>
220
221<p>
222check an array of data against the Hex table.
223<p>
224<dl compact><dt><b>
225Parameters: </b><dd>
226<table border=0 cellspacing=2 cellpadding=0>
227<tr><td valign=top><em>hexData</em>&nbsp;</td><td>
228A string containing the HexBinary</td></tr>
229</table>
230</dl>return: false if it contains any invalid HexBinary true otherwise.     </td>
231  </tr>
232</table>
233<hr>The documentation for this class was generated from the following file:<ul>
234<li><a class="el" href="HexBin_8hpp-source.html">HexBin.hpp</a></ul>
235    </FONT></TD></TR></TABLE><BR>
236</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>
237              Copyright &copy; 1994-2004 The Apache Software Foundation.
238              All Rights Reserved.
239            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.