iconvctl(3) [osx man page]

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

NAME

       iconvctl - control iconv behavior

SYNOPSIS

       #include <iconv.h>

       int iconvctl (iconv_t cd , int request, void * argument);

DESCRIPTION

       The argument cd must be a conversion descriptor created using the function iconv_open.

       iconvctl  queries  or  adjusts  the behavior of the iconv function, when invoked with the specified conversion descriptor, depending on the
       request value.

REQUEST VALUES

       The following are permissible values for the request parameter.

       ICONV_TRIVIALP
	      argument should be an int * which will receive 1 if the conversion is trivial, or 0 otherwise.

       ICONV_GET_TRANSLITERATE
	      argument should be an int * which will receive 1 if transliteration is enabled in the conversion, or 0 otherwise.

       ICONV_SET_TRANSLITERATE
	      argument should be a const int *, pointing to an int value.  A non-zero value is used to enable transliteration in the conversion. A
	      zero value disables it.

       ICONV_GET_DISCARD_ILSEQ
	      argument	should be an int * which will receive 1 if "illegal sequence discard and continue" is enabled in the conversion, or 0 oth-
	      erwise.

       ICONV_SET_DISCARD_ILSEQ
	      argument should be a const int *, pointing to an int value.  A non-zero value is used to enable "illegal sequence discard  and  con-
	      tinue" in the conversion. A zero value disables it.

RETURN VALUE

       The iconvctl function returns 0 if it succeeds. In case of error, it sets errno and returns -1.

ERRORS

       The following errors can occur, among others:

       EINVAL The request is invalid.

CONFORMING TO

       This  function is implemented only in GNU libiconv and not in other iconv implementations. It is not backed by a standard. You can test for
       its presence through (_LIBICONV_VERSION >= 0x0108).

SEE ALSO

       iconv_open(3), iconv(3)

GNU
								 February 2, 2004						       ICONVCTL(3)

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

NAME

       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.  (This implies that a conversion descriptor can not be  used  in  multiple  threads	simultane-
       ously.)	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.

CONFORMING TO

       UNIX98, POSIX.1-2001.

SEE ALSO

       iconv(1), iconv(3), iconv_close(3)

COLOPHON

       This  page is part of release 3.44 of the Linux man-pages project.  A description of the project, and information about reporting bugs, can
       be found at http://www.kernel.org/doc/man-pages/.

GNU
								    2008-08-11							     ICONV_OPEN(3)