embedaddon/libiconv/man/iconvctl.3.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / libiconv / man / iconvctl.3.html
Revision 1.1.1.2 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Wed Mar 17 13:38:46 2021 UTC (3 years, 3 months ago) by misho
Branches: libiconv, MAIN
CVS tags: v1_16p0, HEAD

libiconv 1.16

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta name="generator" content="groff -Thtml, see www.gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <meta name="Content-Style" content="text/css"> <style type="text/css"> p { margin-top: 0; margin-bottom: 0; vertical-align: top } pre { margin-top: 0; margin-bottom: 0; vertical-align: top } table { margin-top: 0; margin-bottom: 0; vertical-align: top } h1 { text-align: center } </style> <title>ICONVCTL</title> </head> <body> <h1 align="center">ICONVCTL</h1> <a href="#NAME">NAME</a>  <a href="#SYNOPSIS">SYNOPSIS</a>  <a href="#DESCRIPTION">DESCRIPTION</a>  <a href="#REQUEST VALUES">REQUEST VALUES</a>  <a href="#RETURN VALUE">RETURN VALUE</a>  <a href="#ERRORS">ERRORS</a>  <a href="#CONFORMING TO">CONFORMING TO</a>  <a href="#SEE ALSO">SEE ALSO</a>  <hr> <h2>NAME <a name="NAME"></a> </h2> iconvctl − control iconv behavior <h2>SYNOPSIS <a name="SYNOPSIS"></a> </h2> #include <iconv.h> int iconvctl (iconv_t cd , int request, void * argument); <h2>DESCRIPTION <a name="DESCRIPTION"></a> </h2> 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. <h2>REQUEST VALUES <a name="REQUEST VALUES"></a> </h2> 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 otherwise. 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 continue" in the conversion. A zero value disables it. <h2>RETURN VALUE <a name="RETURN VALUE"></a> </h2> The iconvctl function returns 0 if it succeeds. In case of error, it sets errno and returns −1. <h2>ERRORS <a name="ERRORS"></a> </h2> The following errors can occur, among others: <table width="100%" border="0" rules="none" frame="void" cellspacing="0" cellpadding="0"> <tr valign="top" align="left"> <td width="11%"></td> <td width="9%"> EINVAL</td> <td width="2%"></td> <td width="35%"> The request is invalid.</td> <td width="43%"> </td></tr> </table> <h2>CONFORMING TO <a name="CONFORMING TO"></a> </h2> 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). <h2>SEE ALSO <a name="SEE ALSO"></a> </h2> iconv_open(3) iconv(3) <hr> </body> </html>