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

Return to iconvctl.3.html CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libiconv / man

Diff for /embedaddon/libiconv/man/iconvctl.3.html between versions 1.1 and 1.1.1.2

version 1.1, 2012/02/21 22:57:48	version 1.1.1.2, 2021/03/17 13:38:46
Line 1	Line 1
	<!-- Creator : groff version 1.22.3 -->
	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
	"http://www.w3.org/TR/html4/loose.dtd">
<html>	<html>
<head>	<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">	<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">	<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>	<title>ICONVCTL</title>

</head>	</head>
<body>	<body>

<h1 align=center>ICONVCTL</h1>	<h1 align="center">ICONVCTL</h1>

<a href="#NAME">NAME</a><br>	<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>	<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>	<a href="#DESCRIPTION">DESCRIPTION</a><br>
Line 17	Line 29
<a href="#SEE ALSO">SEE ALSO</a><br>	<a href="#SEE ALSO">SEE ALSO</a><br>

<hr>	<hr>
<!-- Creator : groff version 1.17.2 -->
<!-- CreationDate: Mon Feb 2 16:48:48 2004 -->
	<h2>NAME
<a name="NAME"></a>	<a name="NAME"></a>
<h2>NAME</h2>	</h2>
<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">	<p style="margin-left:11%; margin-top: 1em">iconvctl
<td width="10%"></td><td width="90%">	− control iconv behavior</p>
iconvctl - control iconv behavior</td></table>
	<h2>SYNOPSIS
<a name="SYNOPSIS"></a>	<a name="SYNOPSIS"></a>
<h2>SYNOPSIS</h2>	</h2>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<pre><b>#include <iconv.h>

int iconvctl (iconv_t</b> <i>cd</i> <b>, int</b> <i>request</i><b>, void *</b> <i>argument</i><b>);	<p style="margin-left:11%; margin-top: 1em"><b>#include
</b></pre></td></table>	<iconv.h></b></p>

	<p style="margin-left:11%; margin-top: 1em"><b>int iconvctl
	(iconv_t</b> <i>cd</i> <b>, int</b> <i>request</i><b>, void
	*</b> <i>argument</i><b>);</b></p>

	<h2>DESCRIPTION
<a name="DESCRIPTION"></a>	<a name="DESCRIPTION"></a>
<h2>DESCRIPTION</h2>	</h2>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
The argument <i>cd</i> must be a conversion descriptor
created using the function <b>iconv_open</b>.</td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:11%; margin-top: 1em">The argument
cols="2" cellspacing="0" cellpadding="0">	<i>cd</i> must be a conversion descriptor created using the
<tr valign="top" align="left">	function <b>iconv_open</b>.</p>
<td width="10%"></td><td width="90%">
<b>iconvctl</b> queries or adjusts the behavior of the
<b>iconv</b> function, when invoked with the specified	<p style="margin-left:11%; margin-top: 1em"><b>iconvctl</b>
conversion descriptor, depending on the request	queries or adjusts the behavior of the <b>iconv</b>
value.</td></table>	function, when invoked with the specified conversion
	descriptor, depending on the request value.</p>

	<h2>REQUEST VALUES
<a name="REQUEST VALUES"></a>	<a name="REQUEST VALUES"></a>
<h2>REQUEST VALUES</h2>	</h2>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
The following are permissible values for the <i>request</i>
parameter.</td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:11%; margin-top: 1em">The following
cols="2" cellspacing="0" cellpadding="0">	are permissible values for the <i>request</i> parameter.
<tr valign="top" align="left">	<b><br>
<td width="10%"></td><td width="90%">	ICONV_TRIVIALP</b></p>
<b>ICONV_TRIVIALP</b></td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:22%;"><i>argument</i> should be an
cols="2" cellspacing="0" cellpadding="0">	<b>int *</b> which will receive 1 if the conversion is
<tr valign="top" align="left">	trivial, or 0 otherwise.</p>
<td width="21%"></td><td width="79%">
<i>argument</i> should be an <b>int *</b> which will receive
1 if the conversion is trivial, or 0 otherwise.</td></table>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>ICONV_GET_TRANSLITERATE</b></td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:11%;"><b>ICONV_GET_TRANSLITERATE</b></p>
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td><td width="79%">
<i>argument</i> should be an <b>int *</b> which will receive
1 if transliteration is enabled in the conversion, or 0
otherwise.</td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:22%;"><i>argument</i> should be an
cols="2" cellspacing="0" cellpadding="0">	<b>int *</b> which will receive 1 if transliteration is
<tr valign="top" align="left">	enabled in the conversion, or 0 otherwise.</p>
<td width="10%"></td><td width="90%">
<b>ICONV_SET_TRANSLITERATE</b></td></table>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="21%"></td><td width="79%">
<i>argument</i> should be a <b>const int *</b>, pointing to
an <b>int</b> value. A non-zero value is used to enable
transliteration in the conversion. A zero value disables
it.</td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:11%;"><b>ICONV_SET_TRANSLITERATE</b></p>
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>ICONV_GET_DISCARD_ILSEQ</b></td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:22%;"><i>argument</i> should be a
cols="2" cellspacing="0" cellpadding="0">	<b>const int *</b>, pointing to an <b>int</b> value. A
<tr valign="top" align="left">	non-zero value is used to enable transliteration in the
<td width="21%"></td><td width="79%">	conversion. A zero value disables it.</p>
<i>argument</i> should be an <b>int *</b> which will receive
1 if "illegal sequence discard and continue" is
enabled in the conversion, or 0 otherwise.</td></table>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>ICONV_SET_DISCARD_ILSEQ</b></td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:11%;"><b>ICONV_GET_DISCARD_ILSEQ</b></p>
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">	<p style="margin-left:22%;"><i>argument</i> should be an
<td width="21%"></td><td width="79%">	<b>int *</b> which will receive 1 if "illegal sequence
<i>argument</i> should be a <b>const int *</b>, pointing to	discard and continue" is enabled in the conversion, or
an <b>int</b> value. A non-zero value is used to enable	0 otherwise.</p>
"illegal sequence discard and continue" in the
conversion. A zero value disables it.</td></table>
	<p style="margin-left:11%;"><b>ICONV_SET_DISCARD_ILSEQ</b></p>

	<p style="margin-left:22%;"><i>argument</i> should be a
	<b>const int *</b>, pointing to an <b>int</b> value. A
	non-zero value is used to enable "illegal sequence
	discard and continue" in the conversion. A zero value
	disables it.</p>

	<h2>RETURN VALUE
<a name="RETURN VALUE"></a>	<a name="RETURN VALUE"></a>
<h2>RETURN VALUE</h2>	</h2>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">	<p style="margin-left:11%; margin-top: 1em">The
<tr valign="top" align="left">	<b>iconvctl</b> function returns 0 if it succeeds. In case
<td width="10%"></td><td width="90%">	of error, it sets <b>errno</b> and returns −1.</p>
The <b>iconvctl</b> function returns 0 if it succeeds. In
case of error, it sets <b>errno</b> and returns	<h2>ERRORS
-1.</td></table>
<a name="ERRORS"></a>	<a name="ERRORS"></a>
<h2>ERRORS</h2>	</h2>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
The following errors can occur, among others:</td></table>

<table width="100%" border=0 rules="none" frame="void"	<p style="margin-left:11%; margin-top: 1em">The following
cols="2" cellspacing="0" cellpadding="0">	errors can occur, among others:</p>
<tr valign="top" align="left">
<td width="10%"></td><td width="90%">
<b>EINVAL</b></td></table>

<table width="100%" border=0 rules="none" frame="void"	<table width="100%" border="0" rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">	cellspacing="0" cellpadding="0">
<tr valign="top" align="left">	<tr valign="top" align="left">
<td width="21%"></td><td width="79%">	<td width="11%"></td>
The request is invalid.</td></table>	<td width="9%">


	<p><b>EINVAL</b></p></td>
	<td width="2%"></td>
	<td width="35%">


	<p>The request is invalid.</p></td>
	<td width="43%">
	</td></tr>
	</table>

	<h2>CONFORMING TO
<a name="CONFORMING TO"></a>	<a name="CONFORMING TO"></a>
<h2>CONFORMING TO</h2>	</h2>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">	<p style="margin-left:11%; margin-top: 1em">This function
<tr valign="top" align="left">	is implemented only in GNU libiconv and not in other
<td width="10%"></td><td width="90%">	<b>iconv</b> implementations. It is not backed by a
This function is implemented only in GNU libiconv and not in
other <b>iconv</b> implementations. It is not backed by a
standard. You can test for its presence through	standard. You can test for its presence through
<b>(_LIBICONV_VERSION >= 0x0108)</b>.</td></table>	<b>(_LIBICONV_VERSION >= 0x0108)</b>.</p>

	<h2>SEE ALSO
<a name="SEE ALSO"></a>	<a name="SEE ALSO"></a>
<h2>SEE ALSO</h2>	</h2>

<table width="100%" border=0 rules="none" frame="void"
cols="2" cellspacing="0" cellpadding="0">
<tr valign="top" align="left">	<p style="margin-left:11%; margin-top: 1em"><b>iconv_open</b>(3)
<td width="10%"></td><td width="90%">	<b>iconv</b>(3)</p>
<b>iconv_open</b>(3), <b>iconv</b>(3)</td></table>
<hr>	<hr>
</body>	</body>
</html>	</html>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.1
changed lines
	Added in v.1.1.1.2