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, 3 months ago) by misho
Branches: libiconv, MAIN
CVS tags: v1_16p0, HEAD

libiconv 1.16

1:  2: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 3: "http://www.w3.org/TR/html4/loose.dtd"> 4: <html> 5: <head> 6: <meta name="generator" content="groff -Thtml, see www.gnu.org"> 7: <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> 8: <meta name="Content-Style" content="text/css"> 9: <style type="text/css"> 10: p { margin-top: 0; margin-bottom: 0; vertical-align: top } 11: pre { margin-top: 0; margin-bottom: 0; vertical-align: top } 12: table { margin-top: 0; margin-bottom: 0; vertical-align: top } 13: h1 { text-align: center } 14: </style> 15: <title>ICONV_OPEN</title> 16: 17: </head> 18: <body> 19: 20: <h1 align="center">ICONV_OPEN</h1> 21: 22: <a href="#NAME">NAME</a>  23: <a href="#SYNOPSIS">SYNOPSIS</a>  24: <a href="#DESCRIPTION">DESCRIPTION</a>  25: <a href="#RETURN VALUE">RETURN VALUE</a>  26: <a href="#ERRORS">ERRORS</a>  27: <a href="#CONFORMING TO">CONFORMING TO</a>  28: <a href="#SEE ALSO">SEE ALSO</a>  29: 30: <hr> 31: 32: 33: <h2>NAME 34: <a name="NAME"></a> 35: </h2> 36: 37: 38: iconv_open 39: − allocate descriptor for character set conversion 40: 41: <h2>SYNOPSIS 42: <a name="SYNOPSIS"></a> 43: </h2> 44: 45: 46: #include 47: <iconv.h> 48: 49: iconv_t 50: iconv_open (const char* tocode, const 51: char* fromcode); 52: 53: <h2>DESCRIPTION 54: <a name="DESCRIPTION"></a> 55: </h2> 56: 57: 58: The 59: iconv_open function allocates a conversion descriptor 60: suitable for converting byte sequences from character 61: encoding fromcode to character encoding 62: tocode. 63: 64: The values 65: permitted for fromcode and tocode and the 66: supported combinations are system dependent. For the 67: libiconv library, the following encodings are supported, in 68: all combinations.   69: European languages 70: 71: ASCII, 72: ISO−8859−{1,2,3,4,5,7,9,10,13,14,15,16}, 73: KOI8−R, KOI8−U, KOI8−RU, 74: CP{1250,1251,1252,1253,1254,1257}, CP{850,866,1131}, 75: Mac{Roman,CentralEurope,Iceland,Croatian,Romania}, 76: Mac{Cyrillic,Ukraine,Greek,Turkish}, Macintosh 77: 78: Semitic languages 79: 80: ISO−8859−{6,8}, 81: CP{1255,1256}, CP862, Mac{Hebrew,Arabic} 82: 83: Japanese 84: 85: EUC−JP, SHIFT_JIS, CP932, 86: ISO−2022−JP, ISO−2022−JP−2, 87: ISO−2022−JP−1, 88: ISO-2022−JP−MS 89: 90: Chinese 91: 92: EUC−CN, HZ, GBK, CP936, 93: GB18030, EUC−TW, BIG5, CP950, BIG5−HKSCS, 94: BIG5−HKSCS:2004, BIG5−HKSCS:2001, 95: BIG5−HKSCS:1999, ISO−2022−CN, 96: ISO−2022−CN−EXT 97: 98: <table width="100%" border="0" rules="none" frame="void" 99: cellspacing="0" cellpadding="0"> 100: <tr valign="top" align="left"> 101: <td width="11%"></td> 102: <td width="9%"> 103: 104: 105: Korean</td> 106: <td width="2%"></td> 107: <td width="50%"> 108: 109: 110: EUC−KR, CP949, ISO−2022−KR, JOHAB</td> 111: <td width="28%"> 112: </td></tr> 113: </table> 114: 115: Armenian 116: 117: ARMSCII−8 118: 119: Georgian 120: 121: Georgian−Academy, 122: Georgian−PS 123: 124: <table width="100%" border="0" rules="none" frame="void" 125: cellspacing="0" cellpadding="0"> 126: <tr valign="top" align="left"> 127: <td width="11%"></td> 128: <td width="9%"> 129: 130: 131: Tajik</td> 132: <td width="2%"></td> 133: <td width="35%"> 134: 135: 136: KOI8−T</td> 137: <td width="43%"> 138: </td></tr> 139: <tr valign="top" align="left"> 140: <td width="11%"></td> 141: <td width="9%"> 142: 143: 144: Kazakh</td> 145: <td width="2%"></td> 146: <td width="35%"> 147: 148: 149: PT154, RK1048</td> 150: <td width="43%"> 151: </td></tr> 152: <tr valign="top" align="left"> 153: <td width="11%"></td> 154: <td width="9%"> 155: 156: 157: Thai</td> 158: <td width="2%"></td> 159: <td width="35%"> 160: 161: 162: TIS−620, CP874, MacThai</td> 163: <td width="43%"> 164: </td></tr> 165: </table> 166: 167: Laotian 168: 169: MuleLao−1, CP1133 170: 171: Vietnamese 172: 173: VISCII, TCVN, CP1258 174: 175: Platform specifics 176: 177: HP−ROMAN8, NEXTSTEP 178: 179: Full Unicode 180: 181: UTF−8   182: UCS−2, UCS−2BE, UCS−2LE   183: UCS−4, UCS−4BE, UCS−4LE   184: UTF−16, UTF−16BE, UTF−16LE   185: UTF−32, UTF−32BE, UTF−32LE   186: UTF−7   187: C99, JAVA 188: 189: Full Unicode, in terms of 190: uint16_t or uint32_t 191: 192: (with machine dependent 193: endianness and alignment)   194: UCS−2−INTERNAL, UCS−4−INTERNAL 195: 196: Locale dependent, in terms of 197: char or wchar_t 198: 199: (with machine dependent 200: endianness and alignment, and with semantics depending on 201: the OS and the current LC_CTYPE locale facet)   202: char, wchar_t 203: 204: When configured 205: with the option 206: −−enable−extra−encodings, it 207: also provides support for a few extra encodings:   208: European languages 209: 210: 211: CP{437,737,775,852,853,855,857,858,860,861,863,865,869,1125} 212: 213: Semitic languages 214: 215: CP864 216: 217: Japanese 218: 219: EUC−JISX0213, 220: Shift_JISX0213, ISO−2022−JP−3 221: 222: Chinese 223: 224: BIG5−2003 225: (experimental) 226: 227: Turkmen 228: 229: TDS565 230: 231: Platform specifics 232: 233: ATARIST, 234: RISCOS−LATIN1 235: 236: The empty 237: encoding name "" is equivalent to 238: "char": it denotes the locale dependent character 239: encoding. 240: 241: When the string 242: "//TRANSLIT" is appended to tocode, 243: transliteration is activated. This means that when a 244: character cannot be represented in the target character set, 245: it can be approximated through one or several characters 246: that look similar to the original character. 247: 248: When the string 249: "//IGNORE" is appended to tocode, 250: characters that cannot be represented in the target 251: character set will be silently discarded. 252: 253: The resulting 254: conversion descriptor can be used with iconv any 255: number of times. It remains valid until deallocated using 256: iconv_close. 257: 258: A conversion 259: descriptor contains a conversion state. After creation using 260: iconv_open, the state is in the initial state. Using 261: iconv modifies the descriptor’s conversion 262: state. (This implies that a conversion descriptor can not be 263: used in multiple threads simultaneously.) To bring the state 264: back to the initial state, use iconv with NULL as 265: inbuf argument. 266: 267: <h2>RETURN VALUE 268: <a name="RETURN VALUE"></a> 269: </h2> 270: 271: 272: The 273: iconv_open function returns a freshly allocated 274: conversion descriptor. In case of error, it sets 275: errno and returns (iconv_t)(−1). 276: 277: <h2>ERRORS 278: <a name="ERRORS"></a> 279: </h2> 280: 281: 282: The following 283: error can occur, among others: 284: 285: <table width="100%" border="0" rules="none" frame="void" 286: cellspacing="0" cellpadding="0"> 287: <tr valign="top" align="left"> 288: <td width="11%"></td> 289: <td width="9%"> 290: 291: 292: EINVAL</td> 293: <td width="2%"></td> 294: <td width="78%"> 295: 296: 297: The conversion from fromcode to tocode is 298: not supported by the implementation.</td></tr> 299: </table> 300: 301: <h2>CONFORMING TO 302: <a name="CONFORMING TO"></a> 303: </h2> 304: 305: 306: POSIX:2001 307: 308: <h2>SEE ALSO 309: <a name="SEE ALSO"></a> 310: </h2> 311: 312: 313: 314: iconv(3) 315: iconvctl(3) iconv_close(3) 316: <hr> 317: </body> 318: </html>