Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

iconv_open(3c) [opensolaris man page]

iconv_open(3C)						   Standard C Library Functions 					    iconv_open(3C)

iconv_open - code conversion allocation function SYNOPSIS
#include <iconv.h> iconv_t iconv_open(const char *tocode, const char *fromcode); DESCRIPTION
The iconv_open() function returns a conversion descriptor that describes a conversion from the codeset specified by the string pointed to by the fromcode argument to the codeset specified by the string pointed to by the tocode argument. For state-dependent encodings, the con- version descriptor will be in a codeset-dependent initial shift state, ready for immediate use with the iconv(3C) function. Settings of fromcode and tocode and their permitted combinations are implementation-dependent. The iconv_open() function supports the alias of the encoding name specified in tocode and fromcode. The alias table of the encoding name is described in the file /usr/lib/iconv/alias. See alias(4). A conversion descriptor remains valid in a process until that process closes it. For examples using the iconv_open() function, see iconv(3C). RETURN VALUES
Upon successful completion iconv_open() returns a conversion descriptor for use on subsequent calls to iconv(). Otherwise, iconv_open() returns (iconv_t) -1 and sets errno to indicate the error. ERRORS
The iconv_open function may fail if: EMFILE {OPEN_MAX} files descriptors are currently open in the calling process. ENFILE Too many files are currently open in the system. ENOMEM Insufficient storage space is available. EINVAL The conversion specified by fromcode and tocode is not supported by the implementation. FILES
/usr/lib/iconv/alias alias table file of the encoding name ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
exec(2), iconv(3C), iconv_close(3C), malloc(3C), alias(4), attributes(5) NOTES
The iconv_open() function uses malloc(3C) to allocate space for internal buffer areas. iconv_open() may fail if there is insufficient stor- age space to accommodate these buffers. Portable applications must assume that conversion descriptors are not valid after a call to one of the exec functions (see exec(2)). SunOS 5.11 2 Oct 2001 iconv_open(3C)

Check Out this Related Man Page

ICONV_OPEN(3)						     Linux Programmer's Manual						     ICONV_OPEN(3)

iconv_open - allocate descriptor for character set conversion SYNOPSIS
#include <iconv.h> iconv_t iconv_open(const char *tocode, const char *fromcode); DESCRIPTION
The iconv_open() function allocates a conversion descriptor suitable for converting byte sequences from character encoding fromcode to character encoding tocode. The values permitted for fromcode and tocode and the supported combinations are system-dependent. For the GNU C library, the permitted values are listed by the iconv --list 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: //TRANSLIT When the string "//TRANSLIT" is appended to tocode, transliteration is activated. This means that when a character cannot be repre- sented in the target character set, it can be approximated through one or several similarly looking characters. //IGNORE When the string "//IGNORE" is appended to tocode, characters that cannot be represented in the target character set will be silently discarded. The resulting conversion descriptor can be used with iconv(3) any number of times. It remains valid until deallocated using iconv_close(3). A conversion descriptor contains a conversion state. After creation using iconv_open(), the state is in the initial state. Using iconv(3) modifies the descriptor's conversion state. To bring the state back to the initial state, use iconv(3) with NULL as inbuf argument. RETURN VALUE
The iconv_open() function returns a freshly allocated conversion descriptor. In case of error, it sets errno and returns (iconv_t) -1. ERRORS
The following error can occur, among others: EINVAL The conversion from fromcode to tocode is not supported by the implementation. VERSIONS
This function is available in glibc since version 2.1. ATTRIBUTES
For an explanation of the terms used in this section, see attributes(7). +-------------+---------------+----------------+ |Interface | Attribute | Value | +-------------+---------------+----------------+ |iconv_open() | Thread safety | MT-Safe locale | +-------------+---------------+----------------+ CONFORMING TO
POSIX.1-2001, POSIX.1-2008, SUSv2. SEE ALSO
iconv(1), iconv(3), iconv_close(3) COLOPHON
This page is part of release 4.15 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at GNU
2017-09-15 ICONV_OPEN(3)
Man Page