iconv_open_into.3.html 4.2 KB

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