<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>Apache Portable Runtime Utility Library: I18N translation library</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>I18N translation library</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga3276c680eb0917ff51ff22c9b9959fa9">APR_DEFAULT_CHARSET</a> (const char *)0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga0e46c333fb1c900f0dd4a78664f5a0de">APR_LOCALE_CHARSET</a> (const char *)1</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___x_l_a_t_e.html#gab7d55348056d7e4cadbc35cfb8e1e624">apr_xlate_open</a> (<a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> **convset, const char *topage, const char *frompage, apr_pool_t *pool)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga578875b2e6b2a19f8466b80e0768792e">apr_xlate_sb_get</a> (<a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset, int *onoff)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___x_l_a_t_e.html#gab92a20b644aa78ca94c6147b254a54f1">apr_xlate_conv_buffer</a> (<a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset, const char *inbuf, apr_size_t *inbytes_left, char *outbuf, apr_size_t *outbytes_left)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">apr_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga90173cefe2dee6e5032ff17b15fea14b">apr_xlate_conv_byte</a> (<a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset, unsigned char inchar)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga2f88b0f72cd2512b8002344308480a8f">apr_xlate_close</a> (<a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> *convset)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga3276c680eb0917ff51ff22c9b9959fa9"></a><!-- doxytag: member="apr_xlate.h::APR_DEFAULT_CHARSET" ref="ga3276c680eb0917ff51ff22c9b9959fa9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_DEFAULT_CHARSET (const char *)0</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is to indicate the charset of the sourcecode at compile time names to indicate the charset of the source code at compile time. This is useful if there are literal strings in the source code which must be translated according to the charset of the source code. </p>
</div>
</div>
<a class="anchor" id="ga0e46c333fb1c900f0dd4a78664f5a0de"></a><!-- doxytag: member="apr_xlate.h::APR_LOCALE_CHARSET" ref="ga0e46c333fb1c900f0dd4a78664f5a0de" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_LOCALE_CHARSET (const char *)1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>To indicate charset names of the current locale </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga069dabbadc30e3a4157c38104a250e77"></a><!-- doxytag: member="apr_xlate.h::apr_xlate_t" ref="ga069dabbadc30e3a4157c38104a250e77" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> <a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opaque translation buffer </p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga2f88b0f72cd2512b8002344308480a8f"></a><!-- doxytag: member="apr_xlate.h::apr_xlate_close" ref="ga2f88b0f72cd2512b8002344308480a8f" args="(apr_xlate_t *convset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_xlate_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> * </td>
<td class="paramname"> <em>convset</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close a codepage translation handle. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>convset</em> </td><td>The codepage translation handle to close </td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Return APR_ENOTIMPL if charset transcoding is not available in this instance of apr-util (i.e., APR_HAS_XLATE is undefined). </dd></dl>
</div>
</div>
<a class="anchor" id="gab92a20b644aa78ca94c6147b254a54f1"></a><!-- doxytag: member="apr_xlate.h::apr_xlate_conv_buffer" ref="gab92a20b644aa78ca94c6147b254a54f1" args="(apr_xlate_t *convset, const char *inbuf, apr_size_t *inbytes_left, char *outbuf, apr_size_t *outbytes_left)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_xlate_conv_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> * </td>
<td class="paramname"> <em>convset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>inbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t * </td>
<td class="paramname"> <em>inbytes_left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>outbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t * </td>
<td class="paramname"> <em>outbytes_left</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a buffer of text from one codepage to another. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>convset</em> </td><td>The handle allocated by apr_xlate_open, specifying the parameters of conversion </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inbuf</em> </td><td>The address of the source buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inbytes_left</em> </td><td>Input: the amount of input data to be translated Output: the amount of input data not yet translated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outbuf</em> </td><td>The address of the destination buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outbytes_left</em> </td><td>Input: the size of the output buffer Output: the amount of the output buffer not yet used </td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Returns APR_ENOTIMPL if charset transcoding is not available in this instance of apr-util (i.e., APR_HAS_XLATE is undefined). Returns APR_INCOMPLETE if the input buffer ends in an incomplete multi-byte character.</dd></dl>
<p>To correctly terminate the output buffer for some multi-byte character set encodings, a final call must be made to this function after the complete input string has been converted, passing the inbuf and inbytes_left parameters as NULL. (Note that this mode only works from version 1.1.0 onwards) </p>
</div>
</div>
<a class="anchor" id="ga90173cefe2dee6e5032ff17b15fea14b"></a><!-- doxytag: member="apr_xlate.h::apr_xlate_conv_byte" ref="ga90173cefe2dee6e5032ff17b15fea14b" args="(apr_xlate_t *convset, unsigned char inchar)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_int32_t apr_xlate_conv_byte </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> * </td>
<td class="paramname"> <em>convset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>inchar</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a single-byte character from one charset to another. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>convset</em> </td><td>The handle allocated by apr_xlate_open, specifying the parameters of conversion </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inchar</em> </td><td>The single-byte character to convert. </td></tr>
</table>
</dd>
</dl>
<dl class="warning"><dt><b>Warning:</b></dt><dd>This only works when converting between single-byte character sets. -1 will be returned if the conversion can't be performed. </dd></dl>
</div>
</div>
<a class="anchor" id="gab7d55348056d7e4cadbc35cfb8e1e624"></a><!-- doxytag: member="apr_xlate.h::apr_xlate_open" ref="gab7d55348056d7e4cadbc35cfb8e1e624" args="(apr_xlate_t **convset, const char *topage, const char *frompage, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_xlate_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> ** </td>
<td class="paramname"> <em>convset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>topage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>frompage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t * </td>
<td class="paramname"> <em>pool</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set up for converting text from one charset to another. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>convset</em> </td><td>The handle to be filled in by this function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>topage</em> </td><td>The name of the target charset </td></tr>
<tr><td valign="top"></td><td valign="top"><em>frompage</em> </td><td>The name of the source charset </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool to use </td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Specify APR_DEFAULT_CHARSET for one of the charset names to indicate the charset of the source code at compile time. This is useful if there are literal strings in the source code which must be translated according to the charset of the source code. APR_DEFAULT_CHARSET is not useful if the source code of the caller was not encoded in the same charset as APR at compile time.</dd>
<dd>
Specify APR_LOCALE_CHARSET for one of the charset names to indicate the charset of the current locale.</dd>
<dd>
Return APR_EINVAL if unable to procure a convset, or APR_ENOTIMPL if charset transcoding is not available in this instance of apr-util at all (i.e., APR_HAS_XLATE is undefined). </dd></dl>
</div>
</div>
<a class="anchor" id="ga578875b2e6b2a19f8466b80e0768792e"></a><!-- doxytag: member="apr_xlate.h::apr_xlate_sb_get" ref="ga578875b2e6b2a19f8466b80e0768792e" args="(apr_xlate_t *convset, int *onoff)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_xlate_sb_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___x_l_a_t_e.html#ga069dabbadc30e3a4157c38104a250e77">apr_xlate_t</a> * </td>
<td class="paramname"> <em>convset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>onoff</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find out whether or not the specified conversion is single-byte-only. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>convset</em> </td><td>The handle allocated by apr_xlate_open, specifying the parameters of conversion </td></tr>
<tr><td valign="top"></td><td valign="top"><em>onoff</em> </td><td>Output: whether or not the conversion is single-byte-only </td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Return APR_ENOTIMPL if charset transcoding is not available in this instance of apr-util (i.e., APR_HAS_XLATE is undefined). </dd></dl>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Feb 1 12:19:48 2012 for Apache Portable Runtime Utility Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
7c859c6f61469ed11e2ab179848b0178
>
files
>
178
