embedaddon/libiconv/man/iconv_open.3.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / libiconv / man / iconv_open.3.html
Revision 1.1.1.3 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Wed Mar 17 13:38:46 2021 UTC (3 years, 9 months ago) by misho
Branches: libiconv, MAIN
CVS tags: v1_16p0, HEAD

libiconv 1.16

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta name="generator" content="groff -Thtml, see www.gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <meta name="Content-Style" content="text/css"> <style type="text/css"> p { margin-top: 0; margin-bottom: 0; vertical-align: top } pre { margin-top: 0; margin-bottom: 0; vertical-align: top } table { margin-top: 0; margin-bottom: 0; vertical-align: top } h1 { text-align: center } </style> <title>ICONV_OPEN</title> </head> <body> <h1 align="center">ICONV_OPEN</h1> <a href="#NAME">NAME</a>  <a href="#SYNOPSIS">SYNOPSIS</a>  <a href="#DESCRIPTION">DESCRIPTION</a>  <a href="#RETURN VALUE">RETURN VALUE</a>  <a href="#ERRORS">ERRORS</a>  <a href="#CONFORMING TO">CONFORMING TO</a>  <a href="#SEE ALSO">SEE ALSO</a>  <hr> <h2>NAME <a name="NAME"></a> </h2> iconv_open − allocate descriptor for character set conversion <h2>SYNOPSIS <a name="SYNOPSIS"></a> </h2> #include <iconv.h> iconv_t iconv_open (const char* tocode, const char* fromcode); <h2>DESCRIPTION <a name="DESCRIPTION"></a> </h2> The iconv_open function allocates a conversion descriptor suitable for converting byte sequences from character encoding fromcode to character encoding tocode. The values permitted for fromcode and tocode and the supported combinations are system dependent. For the libiconv library, the following encodings are supported, in all combinations.   European languages ASCII, ISO−8859−{1,2,3,4,5,7,9,10,13,14,15,16}, KOI8−R, KOI8−U, KOI8−RU, CP{1250,1251,1252,1253,1254,1257}, CP{850,866,1131}, Mac{Roman,CentralEurope,Iceland,Croatian,Romania}, Mac{Cyrillic,Ukraine,Greek,Turkish}, Macintosh Semitic languages ISO−8859−{6,8}, CP{1255,1256}, CP862, Mac{Hebrew,Arabic} Japanese EUC−JP, SHIFT_JIS, CP932, ISO−2022−JP, ISO−2022−JP−2, ISO−2022−JP−1, ISO-2022−JP−MS Chinese EUC−CN, HZ, GBK, CP936, GB18030, EUC−TW, BIG5, CP950, BIG5−HKSCS, BIG5−HKSCS:2004, BIG5−HKSCS:2001, BIG5−HKSCS:1999, ISO−2022−CN, ISO−2022−CN−EXT <table width="100%" border="0" rules="none" frame="void" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="9%"> Korean</td> <td width="2%"></td> <td width="50%"> EUC−KR, CP949, ISO−2022−KR, JOHAB</td> <td width="28%"> </td></tr> </table> Armenian ARMSCII−8 Georgian Georgian−Academy, Georgian−PS <table width="100%" border="0" rules="none" frame="void" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="9%"> Tajik</td> <td width="2%"></td> <td width="35%"> KOI8−T</td> <td width="43%"> </td></tr> <tr valign="top" align="left"> <td width="11%"></td> <td width="9%"> Kazakh</td> <td width="2%"></td> <td width="35%"> PT154, RK1048</td> <td width="43%"> </td></tr> <tr valign="top" align="left"> <td width="11%"></td> <td width="9%"> Thai</td> <td width="2%"></td> <td width="35%"> TIS−620, CP874, MacThai</td> <td width="43%"> </td></tr> </table> Laotian MuleLao−1, CP1133 Vietnamese VISCII, TCVN, CP1258 Platform specifics HP−ROMAN8, NEXTSTEP Full Unicode UTF−8   UCS−2, UCS−2BE, UCS−2LE   UCS−4, UCS−4BE, UCS−4LE   UTF−16, UTF−16BE, UTF−16LE   UTF−32, UTF−32BE, UTF−32LE   UTF−7   C99, JAVA Full Unicode, in terms of uint16_t or uint32_t (with machine dependent endianness and alignment)   UCS−2−INTERNAL, UCS−4−INTERNAL Locale dependent, in terms of char or wchar_t (with machine dependent endianness and alignment, and with semantics depending on the OS and the current LC_CTYPE locale facet)   char, wchar_t When configured with the option −−enable−extra−encodings, it also provides support for a few extra encodings:   European languages CP{437,737,775,852,853,855,857,858,860,861,863,865,869,1125} Semitic languages CP864 Japanese EUC−JISX0213, Shift_JISX0213, ISO−2022−JP−3 Chinese BIG5−2003 (experimental) Turkmen TDS565 Platform specifics ATARIST, RISCOS−LATIN1 The empty encoding name "" is equivalent to "char": it denotes the locale dependent character encoding. When the string "//TRANSLIT" is appended to tocode, transliteration is activated. This means that when a character cannot be represented in the target character set, it can be approximated through one or several characters that look similar to the original character. When the string "//IGNORE" is appended to tocode, characters that cannot be represented in the target character set will be silently discarded. The resulting conversion descriptor can be used with iconv any number of times. It remains valid until deallocated using iconv_close. A conversion descriptor contains a conversion state. After creation using iconv_open, the state is in the initial state. Using iconv modifies the descriptor’s conversion state. (This implies that a conversion descriptor can not be used in multiple threads simultaneously.) To bring the state back to the initial state, use iconv with NULL as inbuf argument. <h2>RETURN VALUE <a name="RETURN VALUE"></a> </h2> The iconv_open function returns a freshly allocated conversion descriptor. In case of error, it sets errno and returns (iconv_t)(−1). <h2>ERRORS <a name="ERRORS"></a> </h2> The following error can occur, among others: <table width="100%" border="0" rules="none" frame="void" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="9%"> EINVAL</td> <td width="2%"></td> <td width="78%"> The conversion from fromcode to tocode is not supported by the implementation.</td></tr> </table> <h2>CONFORMING TO <a name="CONFORMING TO"></a> </h2> POSIX:2001 <h2>SEE ALSO <a name="SEE ALSO"></a> </h2> iconv(3) iconvctl(3) iconv_close(3) <hr> </body> </html>