File size: 7,058 Bytes
651c7e5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | <!-- 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>
<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><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#REQUEST VALUES">REQUEST VALUES</a><br>
<a href="#RETURN VALUE">RETURN VALUE</a><br>
<a href="#ERRORS">ERRORS</a><br>
<a href="#CONFORMING TO">CONFORMING TO</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">iconvctl
− control iconv behavior</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
<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>
</h2>
<p style="margin-left:11%; margin-top: 1em">The argument
<i>cd</i> must be a conversion descriptor created using the
function <b>iconv_open</b>.</p>
<p style="margin-left:11%; margin-top: 1em"><b>iconvctl</b>
queries or adjusts the behavior of the <b>iconv</b>
function, when invoked with the specified conversion
descriptor, depending on the request value.</p>
<h2>REQUEST VALUES
<a name="REQUEST VALUES"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The following
are permissible values for the <i>request</i> parameter.
<b><br>
ICONV_TRIVIALP</b></p>
<p style="margin-left:22%;"><i>argument</i> should be an
<b>int *</b> which will receive 1 if the conversion is
trivial, or 0 otherwise.</p>
<p style="margin-left:11%;"><b>ICONV_GET_TRANSLITERATE</b></p>
<p style="margin-left:22%;"><i>argument</i> should be an
<b>int *</b> which will receive 1 if transliteration is
enabled in the conversion, or 0 otherwise.</p>
<p style="margin-left:11%;"><b>ICONV_SET_TRANSLITERATE</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 transliteration in the
conversion. A zero value disables it.</p>
<p style="margin-left:11%;"><b>ICONV_GET_DISCARD_INVALID</b></p>
<p style="margin-left:22%;"><i>argument</i> should be an
<b>int *</b> which will receive 1 if "discard invalid
multibyte sequence from the input and continue" is
enabled in the conversion, or 0 otherwise.</p>
<p style="margin-left:11%;"><b>ICONV_SET_DISCARD_INVALID</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 "discard invalid
multibyte sequence from the input and continue" in the
conversion. A zero value disables it.</p>
<p style="margin-left:11%;"><b>ICONV_GET_DISCARD_NON_IDENTICAL</b></p>
<p style="margin-left:22%;"><i>argument</i> should be an
<b>int *</b> which will receive 1 if "discard character
that cannot be represented in the target character set and
continue" is enabled in the conversion, or 0
otherwise.</p>
<p style="margin-left:11%;"><b>ICONV_SET_DISCARD_NON_IDENTICAL</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 "discard character
that cannot be represented in the target character set and
continue" in the conversion. A zero value disables
it.</p>
<p style="margin-left:11%;"><b>ICONV_GET_DISCARD_ILSEQ</b></p>
<p style="margin-left:22%;"><i>argument</i> should be an
<b>int *</b> which will receive 1 if both
"discard" behaviours are enabled in the
conversion, or 0 otherwise.</p>
<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 both "discard"
behaviours in the conversion. A zero value disables
them.</p>
<p style="margin-left:11%;"><b>ICONV_GET_FROM_SURFACE</b></p>
<p style="margin-left:22%;"><i>argument</i> should be an
<b>unsigned int *</b> which will receive the from-side
(input side) surface of the conversion.</p>
<p style="margin-left:11%;"><b>ICONV_SET_FROM_SURFACE</b></p>
<p style="margin-left:22%;"><i>argument</i> should be a
<b>const unsigned int *</b>, pointing to an <b>unsigned
int</b> value. This value is installed as the from-side
(input side) surface of the conversion. The value is a bit
mask. Zero denotes no surface. The value
<b>ICONV_SURFACE_EBCDIC_ZOS_UNIX</b> has an effect on EBCDIC
encodings: The EBCDIC newline 0x15 will get mapped to LF
instead of NEL.</p>
<p style="margin-left:11%;"><b>ICONV_GET_TO_SURFACE</b></p>
<p style="margin-left:22%;"><i>argument</i> should be an
<b>unsigned int *</b> which will receive the to-side (output
side) surface of the conversion.</p>
<p style="margin-left:11%;"><b>ICONV_SET_TO_SURFACE</b></p>
<p style="margin-left:22%;"><i>argument</i> should be a
<b>const unsigned int *</b>, pointing to an <b>unsigned
int</b> value. This value is installed as the to-side
(output side) surface of the conversion. The value is a bit
mask. Zero denotes no surface. The value
<b>ICONV_SURFACE_EBCDIC_ZOS_UNIX</b> has an effect on EBCDIC
encodings: LF, instead of NEL, will get mapped to the EBCDIC
newline 0x15.</p>
<h2>RETURN VALUE
<a name="RETURN VALUE"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The
<b>iconvctl</b> function returns 0 if it succeeds. In case
of error, it sets <b>errno</b> and returns −1.</p>
<h2>ERRORS
<a name="ERRORS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The following
errors can occur, among others:</p>
<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%">
<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>
</h2>
<p style="margin-left:11%; margin-top: 1em">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
<b>(_LIBICONV_VERSION >= 0x0108)</b>.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>iconv_open</b>(3)
<b>iconv</b>(3)</p>
<hr>
</body>
</html>
|