classdoor_1_1IConv.html 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Bugz Door Project: door::IConv Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">Bugz Door Project
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.17 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. <div id="nav-path" class="navpath">
  61. <ul>
  62. <li class="navelem"><a class="el" href="namespacedoor.html">door</a></li><li class="navelem"><a class="el" href="classdoor_1_1IConv.html">IConv</a></li> </ul>
  63. </div>
  64. </div><!-- top -->
  65. <div class="header">
  66. <div class="summary">
  67. <a href="#pub-methods">Public Member Functions</a> &#124;
  68. <a href="#pri-attribs">Private Attributes</a> &#124;
  69. <a href="classdoor_1_1IConv-members.html">List of all members</a> </div>
  70. <div class="headertitle">
  71. <div class="title">door::IConv Class Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p>Converts from one encoding to another. Uses iconv (international conversion) API.
  75. <a href="classdoor_1_1IConv.html#details">More...</a></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <tr class="memitem:aa201b347d3982a6b96fc66a9edb36279"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1IConv.html#aa201b347d3982a6b96fc66a9edb36279">IConv</a> (const char *to, const char *from)</td></tr>
  80. <tr class="memdesc:aa201b347d3982a6b96fc66a9edb36279"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a new <a class="el" href="classdoor_1_1IConv.html#aa201b347d3982a6b96fc66a9edb36279" title="Construct a new IConv::IConv object.">IConv::IConv</a> object. <a href="classdoor_1_1IConv.html#aa201b347d3982a6b96fc66a9edb36279">More...</a><br /></td></tr>
  81. <tr class="separator:aa201b347d3982a6b96fc66a9edb36279"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a65f19364b9b6a219dd88e8d8f18db8dc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdoor_1_1IConv.html#a65f19364b9b6a219dd88e8d8f18db8dc">convert</a> (char *input, char *output, size_t outbufsize)</td></tr>
  83. <tr class="memdesc:a65f19364b9b6a219dd88e8d8f18db8dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls iconv API to do the conversion. <a href="classdoor_1_1IConv.html#a65f19364b9b6a219dd88e8d8f18db8dc">More...</a><br /></td></tr>
  84. <tr class="separator:a65f19364b9b6a219dd88e8d8f18db8dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table><table class="memberdecls">
  86. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  87. Private Attributes</h2></td></tr>
  88. <tr class="memitem:ab64b4dfad21ad709b1a17556c3f197be"><td class="memItemLeft" align="right" valign="top"><a id="ab64b4dfad21ad709b1a17556c3f197be"></a>
  89. iconv_t&#160;</td><td class="memItemRight" valign="bottom"><b>ic</b></td></tr>
  90. <tr class="separator:ab64b4dfad21ad709b1a17556c3f197be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table>
  92. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  93. <div class="textblock"><p>Converts from one encoding to another. Uses iconv (international conversion) API. </p>
  94. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  95. <a id="aa201b347d3982a6b96fc66a9edb36279"></a>
  96. <h2 class="memtitle"><span class="permalink"><a href="#aa201b347d3982a6b96fc66a9edb36279">&#9670;&nbsp;</a></span>IConv()</h2>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">door::IConv::IConv </td>
  102. <td>(</td>
  103. <td class="paramtype">const char *&#160;</td>
  104. <td class="paramname"><em>to</em>, </td>
  105. </tr>
  106. <tr>
  107. <td class="paramkey"></td>
  108. <td></td>
  109. <td class="paramtype">const char *&#160;</td>
  110. <td class="paramname"><em>from</em>&#160;</td>
  111. </tr>
  112. <tr>
  113. <td></td>
  114. <td>)</td>
  115. <td></td><td></td>
  116. </tr>
  117. </table>
  118. </div><div class="memdoc">
  119. <p>Construct a new <a class="el" href="classdoor_1_1IConv.html#aa201b347d3982a6b96fc66a9edb36279" title="Construct a new IConv::IConv object.">IConv::IConv</a> object. </p>
  120. <p>Give the encodings that you want to convert to and from. </p><dl class="params"><dt>Parameters</dt><dd>
  121. <table class="params">
  122. <tr><td class="paramname">to</td><td></td></tr>
  123. <tr><td class="paramname">from</td><td></td></tr>
  124. </table>
  125. </dd>
  126. </dl>
  127. </div>
  128. </div>
  129. <h2 class="groupheader">Member Function Documentation</h2>
  130. <a id="a65f19364b9b6a219dd88e8d8f18db8dc"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#a65f19364b9b6a219dd88e8d8f18db8dc">&#9670;&nbsp;</a></span>convert()</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">int door::IConv::convert </td>
  137. <td>(</td>
  138. <td class="paramtype">char *&#160;</td>
  139. <td class="paramname"><em>input</em>, </td>
  140. </tr>
  141. <tr>
  142. <td class="paramkey"></td>
  143. <td></td>
  144. <td class="paramtype">char *&#160;</td>
  145. <td class="paramname"><em>output</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">size_t&#160;</td>
  151. <td class="paramname"><em>outbufsize</em>&#160;</td>
  152. </tr>
  153. <tr>
  154. <td></td>
  155. <td>)</td>
  156. <td></td><td></td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. <p>Calls iconv API to do the conversion. </p>
  161. <p>Buffers must be provided. </p><dl class="params"><dt>Parameters</dt><dd>
  162. <table class="params">
  163. <tr><td class="paramname">input</td><td></td></tr>
  164. <tr><td class="paramname">output</td><td></td></tr>
  165. <tr><td class="paramname">outbufsize</td><td></td></tr>
  166. </table>
  167. </dd>
  168. </dl>
  169. <dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
  170. </div>
  171. </div>
  172. <hr/>The documentation for this class was generated from the following file:<ul>
  173. <li><a class="el" href="door_8cpp.html">door.cpp</a></li>
  174. </ul>
  175. </div><!-- contents -->
  176. <!-- start footer part -->
  177. <hr class="footer"/><address class="footer"><small>
  178. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  179. <img class="footer" src="doxygen.png" alt="doxygen"/>
  180. </a> 1.8.17
  181. </small></address>
  182. </body>
  183. </html>