1 .\" Copyright (c) Bruno Haible <bruno@clisp.org>
3 .\" This is free documentation; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License as
5 .\" published by the Free Software Foundation; either version 3 of
6 .\" the License, or (at your option) any later version.
8 .\" References consulted:
11 .TH ICONV_OPEN_INTO 3 "September 21, 2008" "GNU" "Linux Programmer's Manual"
13 iconv_open_into \- initialize descriptor for character set conversion
18 .BI "int iconv_open_into (const char* " tocode ", const char* " fromcode ","
19 .BI " iconv_allocation_t* " resultp );
22 The \fBiconv_open_into\fP function initializes a conversion descriptor suitable
23 for converting byte sequences from character encoding \fIfromcode\fP to
24 character encoding \fItocode\fP. The conversion descriptor is stored in the
25 memory pointed to by \fIresultp\fP.
27 The values permitted for \fIfromcode\fP and \fItocode\fP are the same as for
28 the function \fBiconv_open\fP.
30 After a successful return from this function, \fIresultp\fP can be be used
31 as an \fBiconv_t\fP object with the \fBiconv\fP function.
33 The \fBiconv_open_into\fP function fills \fB*\fP\fIresultp\fP and returns 0 if
34 it succeeds. In case of error, it sets \fBerrno\fP and returns \-1.
36 The following error can occur, among others:
39 The conversion from \fIfromcode\fP to \fItocode\fP is not supported by the
42 This function is implemented only in GNU libiconv and not in other \fBiconv\fP
43 implementations. It is not backed by a standard. You can test for its presence
44 through \fB(_LIBICONV_VERSION >= 0x010D)\fP.