Annotation of embedaddon/libiconv/man/iconv_open_into.3.html, revision 1.1.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>ICONV_OPEN_INTO</title>
                      6: </head>
                      7: <body>
                      8: 
                      9: <h1 align=center>ICONV_OPEN_INTO</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="#RETURN VALUE">RETURN VALUE</a><br>
                     14: <a href="#ERRORS">ERRORS</a><br>
                     15: <a href="#CONFORMING TO">CONFORMING TO</a><br>
                     16: <a href="#SEE ALSO">SEE ALSO</a><br>
                     17: 
                     18: <hr>
                     19: <!-- Creator     : groff version 1.17.2 -->
                     20: <!-- CreationDate: Sun Sep 21 20:17:11 2008 -->
                     21: <a name="NAME"></a>
                     22: <h2>NAME</h2>
                     23: <table width="100%" border=0 rules="none" frame="void"
                     24:        cols="2" cellspacing="0" cellpadding="0">
                     25: <tr valign="top" align="left">
                     26: <td width="10%"></td><td width="90%">
                     27: iconv_open_into - initialize descriptor for character set conversion</td></table>
                     28: <a name="SYNOPSIS"></a>
                     29: <h2>SYNOPSIS</h2>
                     30: 
                     31: <table width="100%" border=0 rules="none" frame="void"
                     32:        cols="2" cellspacing="0" cellpadding="0">
                     33: <tr valign="top" align="left">
                     34: <td width="10%"></td><td width="90%">
                     35: <pre><b>#include &lt;iconv.h&gt;
                     36: 
                     37: int iconv_open_into (const char*</b> <i>tocode</i><b>, const char*</b> <i>fromcode</i><b>,
                     38:                      iconv_allocation_t*</b> <i>resultp</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 <b>iconv_open_into</b> function initializes a conversion
                     48: descriptor suitable for converting byte sequences from
                     49: character encoding <i>fromcode</i> to character encoding
                     50: <i>tocode</i>. The conversion descriptor is stored in the
                     51: memory pointed to by <i>resultp</i>.</td></table>
                     52: 
                     53: <table width="100%" border=0 rules="none" frame="void"
                     54:        cols="2" cellspacing="0" cellpadding="0">
                     55: <tr valign="top" align="left">
                     56: <td width="10%"></td><td width="90%">
                     57: The values permitted for <i>fromcode</i> and <i>tocode</i>
                     58: are the same as for the function
                     59: <b>iconv_open</b>.</td></table>
                     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: After a successful return from this function, <i>resultp</i>
                     66: can be be used as an <b>iconv_t</b> object with the
                     67: <b>iconv</b> function.</td></table>
                     68: <a name="RETURN VALUE"></a>
                     69: <h2>RETURN VALUE</h2>
                     70: 
                     71: <table width="100%" border=0 rules="none" frame="void"
                     72:        cols="2" cellspacing="0" cellpadding="0">
                     73: <tr valign="top" align="left">
                     74: <td width="10%"></td><td width="90%">
                     75: The <b>iconv_open_into</b> function fills
                     76: <b>*</b><i>resultp</i> and returns 0 if it succeeds. In case
                     77: of error, it sets <b>errno</b> and returns -1.</td></table>
                     78: <a name="ERRORS"></a>
                     79: <h2>ERRORS</h2>
                     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: The following error can occur, among others:</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="10%"></td><td width="90%">
                     91: <b>EINVAL</b></td></table>
                     92: 
                     93: <table width="100%" border=0 rules="none" frame="void"
                     94:        cols="2" cellspacing="0" cellpadding="0">
                     95: <tr valign="top" align="left">
                     96: <td width="21%"></td><td width="79%">
                     97: The conversion from <i>fromcode</i> to <i>tocode</i> is not
                     98: supported by the implementation.</td></table>
                     99: <a name="CONFORMING TO"></a>
                    100: <h2>CONFORMING TO</h2>
                    101: 
                    102: <table width="100%" border=0 rules="none" frame="void"
                    103:        cols="2" cellspacing="0" cellpadding="0">
                    104: <tr valign="top" align="left">
                    105: <td width="10%"></td><td width="90%">
                    106: This function is implemented only in GNU libiconv and not in
                    107: other <b>iconv</b> implementations. It is not backed by a
                    108: standard. You can test for its presence through
                    109: <b>(_LIBICONV_VERSION &gt;= 0x010D)</b>.</td></table>
                    110: <a name="SEE ALSO"></a>
                    111: <h2>SEE ALSO</h2>
                    112: 
                    113: <table width="100%" border=0 rules="none" frame="void"
                    114:        cols="2" cellspacing="0" cellpadding="0">
                    115: <tr valign="top" align="left">
                    116: <td width="10%"></td><td width="90%">
                    117: <b>iconv_open</b>(3) <b>iconv</b>(3)</td></table>
                    118: <hr>
                    119: </body>
                    120: </html>

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