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)

ICONVCTL(3)						   BSD Library Functions Manual 					       ICONVCTL(3)

NAME

     iconvctl -- controlling and diagnostical facility for iconv(3)

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <iconv.h>

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

DESCRIPTION

     The iconvctl() function can retrieve or set specific conversion setting from the cd conversion descriptor.  The request parameter specifies
     the operation to accomplish and argument is an operation-specific argument.

     The possible operations are the following:

     ICONV_TRIVIALP
	     In this case argument is an int * variable, which is set to 1 if the encoding is trivial one, i.e.  the input and output encodings
	     are the same.  Otherwise, the variable will be 0.

     ICONV_GET_TRANSLITERATE
	     Determines if transliteration is enabled.	The answer is stored in argument, which is of int *.  It will be set to 1 if this feature
	     is enabled or set to 0 otherwise.

     ICONV_SET_TRANSLITERATE
	     Enables transliteration if argument, which is of int * set to 1 or disables it if argument is set to 0.

     ICONV_GET_DISCARD_ILSEQ
	     Determines if illegal sequences are discarded or not.  The answer is stored in argument, which is of int *.  It will be set to 1 if
	     this feature is enabled or set to 0 otherwise.

     ICONV_SET_DISCARD_ILSEQ
	     Sets whether illegal sequences are discarded or not.  argument, which is of int * set to 1 or disables it if argument is set to 0.

     ICONV_SET_HOOKS
	     Sets callback functions, which will be called back after successful conversions.  The callback functions are stored in a struct
	     iconv_hooks variable, which is passed to iconvctl via argument by its address.

     ICONV_GET_ILSEQ_INVALID
	     Determines if a character in the input buffer that is valid, but for which an identical character does not exist in the target code-
	     set returns EILSEQ or not.  The answer is stored in argument, which is of int *.  It will be set to 1 if this feature is enabled or
	     set to 0 otherwise.

     ICONV_SET_ILSEQ_INVALID
	     Sets whether a character in the input buffer that is valid, but for which an identical character does not exist in the target codeset
	     returns EILSEQ or not.  If argument, which is of int * is set to 1 it will be enabled, and if argument is set to 0 it will be dis-
	     abled.

RETURN VALUES

     Upon successful completion iconvctl(), returns 0.	Otherwise, -1 is returned and errno is set to specify the kind of error.

ERRORS

     The iconvctl() function may cause an error in the following cases:

     [EINVAL]		Unknown or unimplemented operation.

     [EBADF]		The conversion descriptor specified by cd is invalid.

SEE ALSO

     iconv(1), iconv(3)

STANDARDS

     The iconvctl facility is a non-standard extension, which appeared in the GNU implementation and was adopted in FreeBSD 9.0 for compatibil-
     ity's sake.

AUTHORS

     This manual page was written by Gabor Kovesdan <gabor@FreeBSD.org>.

BUGS

     Transliteration is enabled in this implementation by default, so it is impossible by design to turn it off.  Accordingly, trying to turn it
     off will always fail and -1 will be returned.  Getting the transliteration state will always succeed and indicate that it is turned on,
     though.

BSD
								 November 25, 2009							       BSD