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