196 lines
4.5 KiB
HTML
196 lines
4.5 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of ICONV_OPEN</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>ICONV_OPEN</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
iconv_open - allocate descriptor for character set conversion
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
<B>#include <<A HREF="file:///usr/include/iconv.h">iconv.h</A>></B>
|
|
|
|
<B>iconv_t iconv_open(const char *</B><I>tocode</I><B>, const char *</B><I>fromcode</I><B>);</B>
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>iconv_open</B>()
|
|
|
|
function allocates a conversion descriptor suitable
|
|
for converting byte sequences from character encoding
|
|
<I>fromcode</I>
|
|
|
|
to
|
|
character encoding
|
|
<I>tocode</I>.
|
|
|
|
<P>
|
|
|
|
The values permitted for
|
|
<I>fromcode</I>
|
|
|
|
and
|
|
<I>tocode</I>
|
|
|
|
and the supported
|
|
combinations are system-dependent.
|
|
For the GNU C library, the permitted
|
|
values are listed by the
|
|
<I>iconv --list</I>
|
|
|
|
command, and all combinations
|
|
of the listed values are supported.
|
|
Furthermore the GNU C library and the
|
|
GNU libiconv library support the following two suffixes:
|
|
<DL COMPACT>
|
|
<DT id="1">//TRANSLIT<DD>
|
|
When the string "//TRANSLIT" is appended to
|
|
<I>tocode</I>,
|
|
|
|
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
|
|
similarly looking characters.
|
|
<DT id="2">//IGNORE<DD>
|
|
When the string "//IGNORE" is appended to
|
|
<I>tocode</I>,
|
|
|
|
characters that
|
|
cannot be represented in the target character set will be silently discarded.
|
|
</DL>
|
|
<P>
|
|
|
|
The resulting conversion descriptor can be used with
|
|
<B><A HREF="/cgi-bin/man/man2html?3+iconv">iconv</A></B>(3)
|
|
|
|
any number of times.
|
|
It remains valid until deallocated using
|
|
<B><A HREF="/cgi-bin/man/man2html?3+iconv_close">iconv_close</A></B>(3).
|
|
|
|
<P>
|
|
|
|
A conversion descriptor contains a conversion state.
|
|
After creation using
|
|
<B>iconv_open</B>(),
|
|
|
|
the state is in the initial state.
|
|
Using
|
|
<B><A HREF="/cgi-bin/man/man2html?3+iconv">iconv</A></B>(3)
|
|
|
|
modifies the descriptor's conversion state.
|
|
To bring the state back to the initial state, use
|
|
<B><A HREF="/cgi-bin/man/man2html?3+iconv">iconv</A></B>(3)
|
|
|
|
with NULL as
|
|
<I>inbuf</I>
|
|
|
|
argument.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The
|
|
<B>iconv_open</B>()
|
|
|
|
function returns a freshly allocated conversion
|
|
descriptor.
|
|
In case of error, it sets
|
|
<I>errno</I>
|
|
|
|
and returns
|
|
<I>(iconv_t) -1</I>.
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ERRORS</H2>
|
|
|
|
The following error can occur, among others:
|
|
<DL COMPACT>
|
|
<DT id="3"><B>EINVAL</B>
|
|
|
|
<DD>
|
|
The conversion from
|
|
<I>fromcode</I>
|
|
|
|
to
|
|
<I>tocode</I>
|
|
|
|
is not supported by the
|
|
implementation.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>VERSIONS</H2>
|
|
|
|
This function is available in glibc since version 2.1.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ATTRIBUTES</H2>
|
|
|
|
For an explanation of the terms used in this section, see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
|
|
|
|
<TABLE BORDER>
|
|
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>iconv_open</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Safe locale<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
POSIX.1-2001, POSIX.1-2008, SUSv2.
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+iconv">iconv</A></B>(1),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+iconv">iconv</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+iconv_close">iconv_close</A></B>(3)
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="4"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="5"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="6"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="7"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="8"><A HREF="#lbAF">ERRORS</A><DD>
|
|
<DT id="9"><A HREF="#lbAG">VERSIONS</A><DD>
|
|
<DT id="10"><A HREF="#lbAH">ATTRIBUTES</A><DD>
|
|
<DT id="11"><A HREF="#lbAI">CONFORMING TO</A><DD>
|
|
<DT id="12"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
<DT id="13"><A HREF="#lbAK">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:46 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|