/usr/share/opencc/doc/html/group__opencc__c__api.html is in libopencc2-data 1.0.4-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Open Chinese Convert: OpenCC C API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Open Chinese Convert
 <span id="projectnumber">1.0.4</span>
</div>
<div id="projectbrief">A project for conversion between Traditional and Simplified Chinese</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">OpenCC C API</div> </div>
</div><!--header-->
<div class="contents">
<p>API in C language.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga05b32035094049395f8975f9d2ffa1a2"><td class="memItemLeft" align="right" valign="top"><a id="ga05b32035094049395f8975f9d2ffa1a2"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#ga05b32035094049395f8975f9d2ffa1a2">OPENCC_DEFAULT_CONFIG_SIMP_TO_TRAD</a>   "s2t.json"</td></tr>
<tr class="memdesc:ga05b32035094049395f8975f9d2ffa1a2"><td class="mdescLeft"> </td><td class="mdescRight">Filename of default Simplified to Traditional configuration. <br /></td></tr>
<tr class="separator:ga05b32035094049395f8975f9d2ffa1a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaede2d75ff352d979e89dfc390aa855c8"><td class="memItemLeft" align="right" valign="top"><a id="gaede2d75ff352d979e89dfc390aa855c8"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#gaede2d75ff352d979e89dfc390aa855c8">OPENCC_DEFAULT_CONFIG_TRAD_TO_SIMP</a>   "t2s.json"</td></tr>
<tr class="memdesc:gaede2d75ff352d979e89dfc390aa855c8"><td class="mdescLeft"> </td><td class="mdescRight">Filename of default Traditional to Simplified configuration. <br /></td></tr>
<tr class="separator:gaede2d75ff352d979e89dfc390aa855c8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaa08a1436fedc071dc6fc352c98a6ade9"><td class="memItemLeft" align="right" valign="top"><a id="gaa08a1436fedc071dc6fc352c98a6ade9"></a>
typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a></td></tr>
<tr class="memdesc:gaa08a1436fedc071dc6fc352c98a6ade9"><td class="mdescLeft"> </td><td class="mdescRight">Type of opencc descriptor. <br /></td></tr>
<tr class="separator:gaa08a1436fedc071dc6fc352c98a6ade9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3aa43bc27b880c05c14c15b2c8952336"><td class="memItemLeft" align="right" valign="top">OPENCC_EXPORT <a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#ga3aa43bc27b880c05c14c15b2c8952336">opencc_open</a> (const char *configFileName)</td></tr>
<tr class="memdesc:ga3aa43bc27b880c05c14c15b2c8952336"><td class="mdescLeft"> </td><td class="mdescRight">Makes an instance of opencc. <a href="#ga3aa43bc27b880c05c14c15b2c8952336">More...</a><br /></td></tr>
<tr class="separator:ga3aa43bc27b880c05c14c15b2c8952336"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae4d995fd7bb65e2d4f386aa5cf0dbbb1"><td class="memItemLeft" align="right" valign="top">OPENCC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#gae4d995fd7bb65e2d4f386aa5cf0dbbb1">opencc_close</a> (<a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a> opencc)</td></tr>
<tr class="memdesc:gae4d995fd7bb65e2d4f386aa5cf0dbbb1"><td class="mdescLeft"> </td><td class="mdescRight">Destroys an instance of opencc. <a href="#gae4d995fd7bb65e2d4f386aa5cf0dbbb1">More...</a><br /></td></tr>
<tr class="separator:gae4d995fd7bb65e2d4f386aa5cf0dbbb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9922ab17f25a2d93060292630eb46b81"><td class="memItemLeft" align="right" valign="top">OPENCC_EXPORT size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#ga9922ab17f25a2d93060292630eb46b81">opencc_convert_utf8_to_buffer</a> (<a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a> opencc, const char *input, size_t length, char *output)</td></tr>
<tr class="memdesc:ga9922ab17f25a2d93060292630eb46b81"><td class="mdescLeft"> </td><td class="mdescRight">Converts UTF-8 string. <a href="#ga9922ab17f25a2d93060292630eb46b81">More...</a><br /></td></tr>
<tr class="separator:ga9922ab17f25a2d93060292630eb46b81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaedebe843f05973efd295461be90d50f2"><td class="memItemLeft" align="right" valign="top">OPENCC_EXPORT char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#gaedebe843f05973efd295461be90d50f2">opencc_convert_utf8</a> (<a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a> opencc, const char *input, size_t length)</td></tr>
<tr class="memdesc:gaedebe843f05973efd295461be90d50f2"><td class="mdescLeft"> </td><td class="mdescRight">Converts UTF-8 string This function returns an allocated C-Style string, which stores the converted string. <a href="#gaedebe843f05973efd295461be90d50f2">More...</a><br /></td></tr>
<tr class="separator:gaedebe843f05973efd295461be90d50f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6c11f94e7bee16c080e6d8ab5c16ea84"><td class="memItemLeft" align="right" valign="top">OPENCC_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#ga6c11f94e7bee16c080e6d8ab5c16ea84">opencc_convert_utf8_free</a> (char *str)</td></tr>
<tr class="memdesc:ga6c11f94e7bee16c080e6d8ab5c16ea84"><td class="mdescLeft"> </td><td class="mdescRight">Releases allocated buffer by opencc_convert_utf8. <a href="#ga6c11f94e7bee16c080e6d8ab5c16ea84">More...</a><br /></td></tr>
<tr class="separator:ga6c11f94e7bee16c080e6d8ab5c16ea84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga57698a98df649f5f3f4239419f0867bc"><td class="memItemLeft" align="right" valign="top">OPENCC_EXPORT const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__opencc__c__api.html#ga57698a98df649f5f3f4239419f0867bc">opencc_error</a> (void)</td></tr>
<tr class="memdesc:ga57698a98df649f5f3f4239419f0867bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last error message. <a href="#ga57698a98df649f5f3f4239419f0867bc">More...</a><br /></td></tr>
<tr class="separator:ga57698a98df649f5f3f4239419f0867bc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>API in C language. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae4d995fd7bb65e2d4f386aa5cf0dbbb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae4d995fd7bb65e2d4f386aa5cf0dbbb1">◆ </a></span>opencc_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OPENCC_EXPORT int opencc_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a> </td>
<td class="paramname"><em>opencc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys an instance of opencc. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">opencc</td><td>The description pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or non-zero number on failure. </dd></dl>
</div>
</div>
<a id="gaedebe843f05973efd295461be90d50f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaedebe843f05973efd295461be90d50f2">◆ </a></span>opencc_convert_utf8()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OPENCC_EXPORT char* opencc_convert_utf8 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a> </td>
<td class="paramname"><em>opencc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts UTF-8 string This function returns an allocated C-Style string, which stores the converted string. </p>
<p>You MUST call <a class="el" href="group__opencc__c__api.html#ga6c11f94e7bee16c080e6d8ab5c16ea84" title="Releases allocated buffer by opencc_convert_utf8. ">opencc_convert_utf8_free()</a> to release allocated memory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">opencc</td><td>The opencc description pointer. </td></tr>
<tr><td class="paramname">input</td><td>The UTF-8 encoded string. </td></tr>
<tr><td class="paramname">length</td><td>The maximum length in byte to convert. If length is (size_t)-1, the whole string (terminated by '\0') will be converted.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The newly allocated UTF-8 string that stores text converted, or NULL on error. </dd></dl>
</div>
</div>
<a id="ga6c11f94e7bee16c080e6d8ab5c16ea84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6c11f94e7bee16c080e6d8ab5c16ea84">◆ </a></span>opencc_convert_utf8_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OPENCC_EXPORT void opencc_convert_utf8_free </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases allocated buffer by opencc_convert_utf8. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Pointer to the allocated string buffer by opencc_convert_utf8. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9922ab17f25a2d93060292630eb46b81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9922ab17f25a2d93060292630eb46b81">◆ </a></span>opencc_convert_utf8_to_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OPENCC_EXPORT size_t opencc_convert_utf8_to_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a> </td>
<td class="paramname"><em>opencc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>output</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts UTF-8 string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">opencc</td><td>The opencc description pointer. </td></tr>
<tr><td class="paramname">input</td><td>The UTF-8 encoded string. </td></tr>
<tr><td class="paramname">length</td><td>The maximum length in byte to convert. If length is (size_t)-1, the whole string (terminated by '\0') will be converted. </td></tr>
<tr><td class="paramname">output</td><td>The buffer to store converted text. You MUST make sure this buffer has sufficient space.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The length of converted string or (size_t)-1 on error. </dd></dl>
</div>
</div>
<a id="ga57698a98df649f5f3f4239419f0867bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57698a98df649f5f3f4239419f0867bc">◆ </a></span>opencc_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OPENCC_EXPORT const char* opencc_error </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the last error message. </p>
<p>Note that this function is the only one which is NOT thread-safe. </p>
</div>
</div>
<a id="ga3aa43bc27b880c05c14c15b2c8952336"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3aa43bc27b880c05c14c15b2c8952336">◆ </a></span>opencc_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OPENCC_EXPORT <a class="el" href="group__opencc__c__api.html#gaa08a1436fedc071dc6fc352c98a6ade9">opencc_t</a> opencc_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>configFileName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes an instance of opencc. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">configFileName</td><td>Location of configuration file. If this is set to NULL, OPENCC_DEFAULT_CONFIG_SIMP_TO_TRAD will be loaded. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A description pointer of the newly allocated instance of opencc. On error the return value will be (opencc_t) -1. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 20 2017 07:15:35 for Open Chinese Convert by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|