source: Daodan/MSYS2/mingw32/share/doc/libiconv/iconv_open_into.3.html@ 1166

Last change on this file since 1166 was 1166, checked in by rossy, 3 years ago

Daodan: Replace MinGW build env with an up-to-date MSYS2 env

File size: 3.3 KB
Line 
1<!-- Creator : groff version 1.22.3 -->
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_INTO</title>
16
17</head>
18<body>
19
20<h1 align="center">ICONV_OPEN_INTO</h1>
21
22<a href="#NAME">NAME</a><br>
23<a href="#SYNOPSIS">SYNOPSIS</a><br>
24<a href="#DESCRIPTION">DESCRIPTION</a><br>
25<a href="#RETURN VALUE">RETURN VALUE</a><br>
26<a href="#ERRORS">ERRORS</a><br>
27<a href="#CONFORMING TO">CONFORMING TO</a><br>
28<a href="#SEE ALSO">SEE ALSO</a><br>
29
30<hr>
31
32
33<h2>NAME
34<a name="NAME"></a>
35</h2>
36
37
38
39<p style="margin-left:11%; margin-top: 1em">iconv_open_into
40&minus; initialize descriptor for character set
41conversion</p>
42
43<h2>SYNOPSIS
44<a name="SYNOPSIS"></a>
45</h2>
46
47
48<p style="margin-left:11%; margin-top: 1em"><b>#include
49&lt;iconv.h&gt;</b></p>
50
51<p style="margin-left:11%; margin-top: 1em"><b>int
52iconv_open_into (const char*</b> <i>tocode</i><b>, const
53char*</b> <i>fromcode</i><b>, <br>
54iconv_allocation_t*</b> <i>resultp</i><b>);</b></p>
55
56<h2>DESCRIPTION
57<a name="DESCRIPTION"></a>
58</h2>
59
60
61<p style="margin-left:11%; margin-top: 1em">The
62<b>iconv_open_into</b> function initializes a conversion
63descriptor suitable for converting byte sequences from
64character encoding <i>fromcode</i> to character encoding
65<i>tocode</i>. The conversion descriptor is stored in the
66memory pointed to by <i>resultp</i>.</p>
67
68<p style="margin-left:11%; margin-top: 1em">The values
69permitted for <i>fromcode</i> and <i>tocode</i> are the same
70as for the function <b>iconv_open</b>.</p>
71
72<p style="margin-left:11%; margin-top: 1em">After a
73successful return from this function, <i>resultp</i> can be
74be used as an <b>iconv_t</b> object with the <b>iconv</b>
75function.</p>
76
77<h2>RETURN VALUE
78<a name="RETURN VALUE"></a>
79</h2>
80
81
82<p style="margin-left:11%; margin-top: 1em">The
83<b>iconv_open_into</b> function fills <b>*</b><i>resultp</i>
84and returns 0 if it succeeds. In case of error, it sets
85<b>errno</b> and returns &minus;1.</p>
86
87<h2>ERRORS
88<a name="ERRORS"></a>
89</h2>
90
91
92<p style="margin-left:11%; margin-top: 1em">The following
93error can occur, among others:</p>
94
95<table width="100%" border="0" rules="none" frame="void"
96 cellspacing="0" cellpadding="0">
97<tr valign="top" align="left">
98<td width="11%"></td>
99<td width="9%">
100
101
102<p><b>EINVAL</b></p></td>
103<td width="2%"></td>
104<td width="78%">
105
106
107<p>The conversion from <i>fromcode</i> to <i>tocode</i> is
108not supported by the implementation.</p></td></tr>
109</table>
110
111<h2>CONFORMING TO
112<a name="CONFORMING TO"></a>
113</h2>
114
115
116<p style="margin-left:11%; margin-top: 1em">This function
117is implemented only in GNU libiconv and not in other
118<b>iconv</b> implementations. It is not backed by a
119standard. You can test for its presence through
120<b>(_LIBICONV_VERSION &gt;= 0x010D)</b>.</p>
121
122<h2>SEE ALSO
123<a name="SEE ALSO"></a>
124</h2>
125
126
127
128<p style="margin-left:11%; margin-top: 1em"><b>iconv_open</b>(3)
129<b>iconv</b>(3)</p>
130<hr>
131</body>
132</html>
Note: See TracBrowser for help on using the repository browser.