1: <!-- Creator : groff version 1.22.3 -->
2: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
3: "http://www.w3.org/TR/html4/loose.dtd">
4: <html>
5: <head>
6: <meta name="generator" content="groff -Thtml, see www.gnu.org">
7: <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
8: <meta name="Content-Style" content="text/css">
9: <style type="text/css">
10: p { margin-top: 0; margin-bottom: 0; vertical-align: top }
11: pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
12: table { margin-top: 0; margin-bottom: 0; vertical-align: top }
13: h1 { text-align: center }
14: </style>
15: <title>ICONVCTL</title>
16:
17: </head>
18: <body>
19:
20: <h1 align="center">ICONVCTL</h1>
21:
22: <a href="#NAME">NAME</a><br>
23: <a href="#SYNOPSIS">SYNOPSIS</a><br>
24: <a href="#DESCRIPTION">DESCRIPTION</a><br>
25: <a href="#REQUEST VALUES">REQUEST VALUES</a><br>
26: <a href="#RETURN VALUE">RETURN VALUE</a><br>
27: <a href="#ERRORS">ERRORS</a><br>
28: <a href="#CONFORMING TO">CONFORMING TO</a><br>
29: <a href="#SEE ALSO">SEE ALSO</a><br>
30:
31: <hr>
32:
33:
34: <h2>NAME
35: <a name="NAME"></a>
36: </h2>
37:
38:
39: <p style="margin-left:11%; margin-top: 1em">iconvctl
40: − control iconv behavior</p>
41:
42: <h2>SYNOPSIS
43: <a name="SYNOPSIS"></a>
44: </h2>
45:
46:
47: <p style="margin-left:11%; margin-top: 1em"><b>#include
48: <iconv.h></b></p>
49:
50: <p style="margin-left:11%; margin-top: 1em"><b>int iconvctl
51: (iconv_t</b> <i>cd</i> <b>, int</b> <i>request</i><b>, void
52: *</b> <i>argument</i><b>);</b></p>
53:
54: <h2>DESCRIPTION
55: <a name="DESCRIPTION"></a>
56: </h2>
57:
58:
59: <p style="margin-left:11%; margin-top: 1em">The argument
60: <i>cd</i> must be a conversion descriptor created using the
61: function <b>iconv_open</b>.</p>
62:
63:
64: <p style="margin-left:11%; margin-top: 1em"><b>iconvctl</b>
65: queries or adjusts the behavior of the <b>iconv</b>
66: function, when invoked with the specified conversion
67: descriptor, depending on the request value.</p>
68:
69: <h2>REQUEST VALUES
70: <a name="REQUEST VALUES"></a>
71: </h2>
72:
73:
74: <p style="margin-left:11%; margin-top: 1em">The following
75: are permissible values for the <i>request</i> parameter.
76: <b><br>
77: ICONV_TRIVIALP</b></p>
78:
79: <p style="margin-left:22%;"><i>argument</i> should be an
80: <b>int *</b> which will receive 1 if the conversion is
81: trivial, or 0 otherwise.</p>
82:
83:
84: <p style="margin-left:11%;"><b>ICONV_GET_TRANSLITERATE</b></p>
85:
86: <p style="margin-left:22%;"><i>argument</i> should be an
87: <b>int *</b> which will receive 1 if transliteration is
88: enabled in the conversion, or 0 otherwise.</p>
89:
90:
91: <p style="margin-left:11%;"><b>ICONV_SET_TRANSLITERATE</b></p>
92:
93: <p style="margin-left:22%;"><i>argument</i> should be a
94: <b>const int *</b>, pointing to an <b>int</b> value. A
95: non-zero value is used to enable transliteration in the
96: conversion. A zero value disables it.</p>
97:
98:
99: <p style="margin-left:11%;"><b>ICONV_GET_DISCARD_ILSEQ</b></p>
100:
101: <p style="margin-left:22%;"><i>argument</i> should be an
102: <b>int *</b> which will receive 1 if "illegal sequence
103: discard and continue" is enabled in the conversion, or
104: 0 otherwise.</p>
105:
106:
107: <p style="margin-left:11%;"><b>ICONV_SET_DISCARD_ILSEQ</b></p>
108:
109: <p style="margin-left:22%;"><i>argument</i> should be a
110: <b>const int *</b>, pointing to an <b>int</b> value. A
111: non-zero value is used to enable "illegal sequence
112: discard and continue" in the conversion. A zero value
113: disables it.</p>
114:
115: <h2>RETURN VALUE
116: <a name="RETURN VALUE"></a>
117: </h2>
118:
119:
120: <p style="margin-left:11%; margin-top: 1em">The
121: <b>iconvctl</b> function returns 0 if it succeeds. In case
122: of error, it sets <b>errno</b> and returns −1.</p>
123:
124: <h2>ERRORS
125: <a name="ERRORS"></a>
126: </h2>
127:
128:
129: <p style="margin-left:11%; margin-top: 1em">The following
130: errors can occur, among others:</p>
131:
132: <table width="100%" border="0" rules="none" frame="void"
133: cellspacing="0" cellpadding="0">
134: <tr valign="top" align="left">
135: <td width="11%"></td>
136: <td width="9%">
137:
138:
139: <p><b>EINVAL</b></p></td>
140: <td width="2%"></td>
141: <td width="35%">
142:
143:
144: <p>The request is invalid.</p></td>
145: <td width="43%">
146: </td></tr>
147: </table>
148:
149: <h2>CONFORMING TO
150: <a name="CONFORMING TO"></a>
151: </h2>
152:
153:
154: <p style="margin-left:11%; margin-top: 1em">This function
155: is implemented only in GNU libiconv and not in other
156: <b>iconv</b> implementations. It is not backed by a
157: standard. You can test for its presence through
158: <b>(_LIBICONV_VERSION >= 0x0108)</b>.</p>
159:
160: <h2>SEE ALSO
161: <a name="SEE ALSO"></a>
162: </h2>
163:
164:
165:
166: <p style="margin-left:11%; margin-top: 1em"><b>iconv_open</b>(3)
167: <b>iconv</b>(3)</p>
168: <hr>
169: </body>
170: </html>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to iconvctl.3.html CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libiconv / man