You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

239 lines
12 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.9.1"/>
  7. <title>Xerces-C++: HexBin Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">Xerces-C++
  21. &#160;<span id="projectnumber">3.1.2</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.9.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  35. <li><a href="files.html"><span>Files</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="classHexBin-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">HexBin Class Reference</div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <table class="memberdecls">
  55. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  56. Static Public Member Functions</h2></td></tr>
  57. <tr><td colspan="2"><div class="groupHeader"></div></td></tr>
  58. <tr class="memitem:a5ee657128c61a8323da8ba1d91219d2a"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHexBin.html#a5ee657128c61a8323da8ba1d91219d2a">getDataLength</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const hexData)</td></tr>
  59. <tr class="memdesc:a5ee657128c61a8323da8ba1d91219d2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the length of hexData in terms of HexBinary. <a href="#a5ee657128c61a8323da8ba1d91219d2a">More...</a><br /></td></tr>
  60. <tr class="separator:a5ee657128c61a8323da8ba1d91219d2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a051fef29ff88122b1c5303fbdf095882"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHexBin.html#a051fef29ff88122b1c5303fbdf095882">isArrayByteHex</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const hexData)</td></tr>
  62. <tr class="memdesc:a051fef29ff88122b1c5303fbdf095882"><td class="mdescLeft">&#160;</td><td class="mdescRight">check an array of data against the Hex table. <a href="#a051fef29ff88122b1c5303fbdf095882">More...</a><br /></td></tr>
  63. <tr class="separator:a051fef29ff88122b1c5303fbdf095882"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a7abc9675188fc6d96307cbe28e956995"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHexBin.html#a7abc9675188fc6d96307cbe28e956995">getCanonicalRepresentation</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const hexData, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
  65. <tr class="memdesc:a7abc9675188fc6d96307cbe28e956995"><td class="mdescLeft">&#160;</td><td class="mdescRight">get canonical representation <a href="#a7abc9675188fc6d96307cbe28e956995">More...</a><br /></td></tr>
  66. <tr class="separator:a7abc9675188fc6d96307cbe28e956995"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a3c633d755f9768e9e0e6e5225617eb53"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="XercesDefs_8hpp.html#a7470c7a32c59355685ebcd878a33f126">XMLByte</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHexBin.html#a3c633d755f9768e9e0e6e5225617eb53">decodeToXMLByte</a> (const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const hexData, <a class="el" href="classMemoryManager.html">MemoryManager</a> *const manager=<a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
  68. <tr class="memdesc:a3c633d755f9768e9e0e6e5225617eb53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes HexBinary data into XMLByte. <a href="#a3c633d755f9768e9e0e6e5225617eb53">More...</a><br /></td></tr>
  69. <tr class="separator:a3c633d755f9768e9e0e6e5225617eb53"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. </table>
  71. <h2 class="groupheader">Member Function Documentation</h2>
  72. <a class="anchor" id="a3c633d755f9768e9e0e6e5225617eb53"></a>
  73. <div class="memitem">
  74. <div class="memproto">
  75. <table class="mlabels">
  76. <tr>
  77. <td class="mlabels-left">
  78. <table class="memname">
  79. <tr>
  80. <td class="memname">static <a class="el" href="XercesDefs_8hpp.html#a7470c7a32c59355685ebcd878a33f126">XMLByte</a>* HexBin::decodeToXMLByte </td>
  81. <td>(</td>
  82. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const&#160;</td>
  83. <td class="paramname"><em>hexData</em>, </td>
  84. </tr>
  85. <tr>
  86. <td class="paramkey"></td>
  87. <td></td>
  88. <td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&#160;</td>
  89. <td class="paramname"><em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code>&#160;</td>
  90. </tr>
  91. <tr>
  92. <td></td>
  93. <td>)</td>
  94. <td></td><td></td>
  95. </tr>
  96. </table>
  97. </td>
  98. <td class="mlabels-right">
  99. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  100. </tr>
  101. </table>
  102. </div><div class="memdoc">
  103. <p>Decodes HexBinary data into XMLByte. </p>
  104. <p>NOTE: The returned buffer is dynamically allocated and is the responsibility of the caller to delete it when not longer needed. Use the memory manager to release the returned buffer.</p>
  105. <dl class="params"><dt>Parameters</dt><dd>
  106. <table class="params">
  107. <tr><td class="paramname">hexData</td><td>HexBinary data in XMLCh stream. </td></tr>
  108. <tr><td class="paramname">manager</td><td>client provided memory manager </td></tr>
  109. </table>
  110. </dd>
  111. </dl>
  112. <dl class="section return"><dt>Returns</dt><dd>Decoded binary data in XMLByte stream, or NULL if input data can not be decoded. </dd></dl>
  113. </div>
  114. </div>
  115. <a class="anchor" id="a7abc9675188fc6d96307cbe28e956995"></a>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="mlabels">
  119. <tr>
  120. <td class="mlabels-left">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname">static <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a>* HexBin::getCanonicalRepresentation </td>
  124. <td>(</td>
  125. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const&#160;</td>
  126. <td class="paramname"><em>hexData</em>, </td>
  127. </tr>
  128. <tr>
  129. <td class="paramkey"></td>
  130. <td></td>
  131. <td class="paramtype"><a class="el" href="classMemoryManager.html">MemoryManager</a> *const&#160;</td>
  132. <td class="paramname"><em>manager</em> = <code><a class="el" href="classXMLPlatformUtils.html#a97eff0d9fff3567bea3acd3ca4d95252">XMLPlatformUtils::fgMemoryManager</a></code>&#160;</td>
  133. </tr>
  134. <tr>
  135. <td></td>
  136. <td>)</td>
  137. <td></td><td></td>
  138. </tr>
  139. </table>
  140. </td>
  141. <td class="mlabels-right">
  142. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>get canonical representation </p>
  147. <p>Caller is responsible for the proper deallocation of the string returned.</p>
  148. <dl class="params"><dt>Parameters</dt><dd>
  149. <table class="params">
  150. <tr><td class="paramname">hexData</td><td>A string containing the HexBinary </td></tr>
  151. <tr><td class="paramname">manager</td><td>The <a class="el" href="classMemoryManager.html" title="Configurable memory manager. ">MemoryManager</a> to use to allocate the string</td></tr>
  152. </table>
  153. </dd>
  154. </dl>
  155. <p>return: the canonical representation of the HexBinary if it is a valid HexBinary, 0 otherwise </p>
  156. </div>
  157. </div>
  158. <a class="anchor" id="a5ee657128c61a8323da8ba1d91219d2a"></a>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="mlabels">
  162. <tr>
  163. <td class="mlabels-left">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">static int HexBin::getDataLength </td>
  167. <td>(</td>
  168. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const&#160;</td>
  169. <td class="paramname"><em>hexData</em></td><td>)</td>
  170. <td></td>
  171. </tr>
  172. </table>
  173. </td>
  174. <td class="mlabels-right">
  175. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>return the length of hexData in terms of HexBinary. </p>
  180. <dl class="params"><dt>Parameters</dt><dd>
  181. <table class="params">
  182. <tr><td class="paramname">hexData</td><td>A string containing the HexBinary</td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. <p>return: -1 if it contains any invalid HexBinary the length of the HexNumber otherwise. </p>
  187. </div>
  188. </div>
  189. <a class="anchor" id="a051fef29ff88122b1c5303fbdf095882"></a>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="mlabels">
  193. <tr>
  194. <td class="mlabels-left">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">static bool HexBin::isArrayByteHex </td>
  198. <td>(</td>
  199. <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const&#160;</td>
  200. <td class="paramname"><em>hexData</em></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <p>check an array of data against the Hex table. </p>
  211. <dl class="params"><dt>Parameters</dt><dd>
  212. <table class="params">
  213. <tr><td class="paramname">hexData</td><td>A string containing the HexBinary</td></tr>
  214. </table>
  215. </dd>
  216. </dl>
  217. <p>return: false if it contains any invalid HexBinary true otherwise. </p>
  218. </div>
  219. </div>
  220. <hr/>The documentation for this class was generated from the following file:<ul>
  221. <li><a class="el" href="HexBin_8hpp_source.html">HexBin.hpp</a></li>
  222. </ul>
  223. </div><!-- contents -->
  224. <!-- start footer part -->
  225. <hr class="footer"/><address class="footer"><small>
  226. Generated on Wed Mar 18 2015 10:43:38 for Xerces-C++ by &#160;<a href="http://www.doxygen.org/index.html">
  227. <img class="footer" src="doxygen.png" alt="doxygen"/>
  228. </a> 1.8.9.1
  229. </small></address>
  230. </body>
  231. </html>