2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
|
.\"
|
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
|
.\"
|
|
|
|
|
.\" References consulted:
|
|
|
|
|
.\" GNU glibc-2 source code and manual
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
.\" OpenGroup's Single UNIX specification
|
2007-04-27 16:45:22 +00:00
|
|
|
.\" http://www.UNIX-systems.org/online.html
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
2007-06-21 22:55:04 +00:00
|
|
|
.\" 2007-03-31 Bruno Haible, Describe the glibc/libiconv //TRANSLIT
|
|
|
|
|
.\" and //IGNORE extensions for 'tocode'.
|
2007-04-27 16:45:22 +00:00
|
|
|
.\"
|
2008-08-11 20:23:22 +00:00
|
|
|
.TH ICONV_OPEN 3 2008-08-11 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
|
iconv_open \- allocate descriptor for character set conversion
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
.B #include <iconv.h>
|
|
|
|
|
.sp
|
|
|
|
|
.BI "iconv_t iconv_open(const char *" tocode ", const char *" fromcode );
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR iconv_open ()
|
|
|
|
|
function allocates a conversion descriptor suitable
|
2004-11-03 13:51:07 +00:00
|
|
|
for converting byte sequences from character encoding \fIfromcode\fP to
|
|
|
|
|
character encoding \fItocode\fP.
|
|
|
|
|
.PP
|
|
|
|
|
The values permitted for \fIfromcode\fP and \fItocode\fP and the supported
|
2007-12-26 11:17:23 +00:00
|
|
|
combinations are system-dependent.
|
2007-04-12 22:42:49 +00:00
|
|
|
For the GNU C library, the permitted
|
2005-07-06 08:00:30 +00:00
|
|
|
values are listed by the \fBiconv \-\-list\fP command, and all combinations
|
2004-11-03 13:51:07 +00:00
|
|
|
of the listed values are supported.
|
2007-04-27 16:45:22 +00:00
|
|
|
Furthermore the GNU C library and the
|
|
|
|
|
GNU libiconv library support the following two suffixes:
|
|
|
|
|
.TP
|
|
|
|
|
//TRANSLIT
|
|
|
|
|
When the string "//TRANSLIT" is appended to \fItocode\fP, 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.
|
|
|
|
|
.TP
|
|
|
|
|
//IGNORE
|
|
|
|
|
When the string "//IGNORE" is appended to \fItocode\fP, characters that
|
|
|
|
|
cannot be represented in the target character set will be silently discarded.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The resulting conversion descriptor can be used with
|
2007-06-21 22:55:04 +00:00
|
|
|
.BR iconv (3)
|
2007-04-27 16:45:22 +00:00
|
|
|
any number of times.
|
2007-05-12 09:06:04 +00:00
|
|
|
It remains valid until deallocated using
|
2007-05-21 22:14:09 +00:00
|
|
|
.BR iconv_close (3).
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
A conversion descriptor contains a conversion state.
|
|
|
|
|
After creation using
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR iconv_open (),
|
|
|
|
|
the state is in the initial state.
|
|
|
|
|
Using
|
2007-05-21 22:14:09 +00:00
|
|
|
.BR iconv (3)
|
2007-04-12 22:42:49 +00:00
|
|
|
modifies the descriptor's conversion state.
|
|
|
|
|
(This implies that a conversion
|
|
|
|
|
descriptor can not be used in multiple threads simultaneously.)
|
2007-05-12 09:06:04 +00:00
|
|
|
To bring the state back to the initial state, use
|
2007-05-21 22:14:09 +00:00
|
|
|
.BR iconv (3)
|
2007-04-12 22:42:49 +00:00
|
|
|
with NULL as \fIinbuf\fP argument.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR iconv_open ()
|
|
|
|
|
function returns a freshly allocated conversion
|
2007-04-12 22:42:49 +00:00
|
|
|
descriptor.
|
2007-07-09 21:33:55 +00:00
|
|
|
In case of error, it sets \fIerrno\fP and returns
|
2007-12-22 16:26:51 +00:00
|
|
|
.IR (iconv_t)\ \-1 .
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH ERRORS
|
|
|
|
|
The following error can occur, among others:
|
|
|
|
|
.TP
|
|
|
|
|
.B EINVAL
|
|
|
|
|
The conversion from \fIfromcode\fP to \fItocode\fP is not supported by the
|
|
|
|
|
implementation.
|
2008-08-11 20:23:22 +00:00
|
|
|
.SH VERSIONS
|
|
|
|
|
This function is available in glibc since version 2.1.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:30 +00:00
|
|
|
UNIX98, POSIX.1-2001.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR iconv (1),
|
|
|
|
|
.BR iconv (3),
|
|
|
|
|
.BR iconv_close (3)
|