iconv_open - codeset conversion allocation function
iconv_t iconv_open(const char *tocode, const char *fromcode);
The iconv_open() function shall return 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 conversion descriptor shall be in a codeset-dependent initial shift state, ready for immediate use with iconv().
Settings of fromcode and tocode and their permitted combinations are implementation-defined.
A conversion descriptor shall remain valid until it is closed by iconv_close() or an implicit close.
If a file descriptor is used to implement conversion descriptors, the FD_CLOEXEC flag shall be set; see <fcntl.h>.
Upon successful completion, iconv_open() shall return a conversion descriptor for use on subsequent calls to iconv(). Otherwise, iconv_open() shall return (iconv_t)-1 and set errno to indicate the error.
The iconv_open() function may fail if:
- All file descriptors available to the process are currently open.
- Too many files are currently open in the system.
- Insufficient storage space is available.
- The conversion specified by fromcode and tocode is not supported by the implementation.
Some implementations of iconv_open() use malloc() to allocate space for internal buffer areas. The iconv_open() function may fail if there is insufficient storage space to accommodate these buffers.
Conforming applications must assume that conversion descriptors are not valid after a call to one of the exec functions.
Application developers should consult the system documentation to determine the supported codesets and their naming schemes.
XBD <fcntl.h>, <iconv.h>
First released in Issue 4. Derived from the HP-UX Manual.
SD5-XBD-ERN-4 is applied, changing the definition of the [EMFILE] error.
The iconv_open() function is moved from the XSI option to the Base.
return to top of page