man/iconv.3

   1 .\" Copyright (c) Free Software Foundation, Inc.
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 3 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
  11 .\"
  12 .TH ICONV 3  "May 24, 2023" "GNU"
  13 .SH NAME
  14 iconv \- perform character set conversion
  15 .SH SYNOPSIS
  16 .nf
  17 .B #include <iconv.h>
  18 .sp
  19 .BI "size_t iconv (iconv_t " cd ,
  20 .BI "              const char* * " inbuf ", size_t * "inbytesleft ,
  21 .BI "              char* * " outbuf ", size_t * "outbytesleft );
  22 .fi
  23 .SH DESCRIPTION
  24 The argument \fIcd\fP must be a conversion descriptor created using the
  25 function \fBiconv_open\fP.
  26 .PP
  27 The main case is when \fIinbuf\fP is not NULL and \fI*inbuf\fP is not NULL.
  28 In this case, the \fBiconv\fP function converts the multibyte sequence
  29 starting at \fI*inbuf\fP to a multibyte sequence starting at \fI*outbuf\fP.
  30 At most \fI*inbytesleft\fP bytes, starting at \fI*inbuf\fP, will be read.
  31 At most \fI*outbytesleft\fP bytes, starting at \fI*outbuf\fP, will be written.
  32 .PP
  33 The \fBiconv\fP function converts one multibyte character at a time, and for
  34 each character conversion it increments \fI*inbuf\fP and decrements
  35 \fI*inbytesleft\fP by the number of converted input bytes, it increments
  36 \fI*outbuf\fP and decrements \fI*outbytesleft\fP by the number of converted
  37 output bytes, and it updates the conversion state contained in \fIcd\fP.
  38 If the character encoding of the input is stateful, the \fBiconv\fP function
  39 can also convert a sequence of input bytes to an update of the conversion state
  40 without producing any output bytes; such input is called a \fIshift sequence\fP.
  41 The conversion can stop for five reasons:
  42 .PP
  43 1. An invalid multibyte sequence is encountered in the input. In this case
  44 it sets \fBerrno\fP to \fBEILSEQ\fP and returns (size_t)(\-1). \fI*inbuf\fP
  45 is left pointing to the beginning of the invalid multibyte sequence.
  46 .PP
  47 2. The input byte sequence has been entirely converted, i.e. \fI*inbytesleft\fP
  48 has gone down to 0. In this case \fBiconv\fP returns the number of
  49 non-reversible conversions performed during this call.
  50 .PP
  51 3. An incomplete multibyte sequence is encountered in the input, and the
  52 input byte sequence terminates after it. In this case it sets \fBerrno\fP to
  53 \fBEINVAL\fP and returns (size_t)(\-1). \fI*inbuf\fP is left pointing to the
  54 beginning of the incomplete multibyte sequence.
  55 .PP
  56 4. A multibyte sequence is encountered that is valid but that cannot be
  57 translated to the character encoding of the output.
  58 This condition depends on the implementation and on the conversion
  59 descriptor.
  60 In the GNU C library and GNU libiconv, if \fIcd\fP was created without the
  61 suffix \fB//TRANSLIT\fP or \fB//IGNORE\fP, the conversion is strict: lossy
  62 conversions produce this condition.
  63 If the suffix \fB//TRANSLIT\fP was specified, transliteration can avoid this
  64 condition in some cases.
  65 In the musl C library, this condition cannot occur because a conversion to
  66 \fB\[aq]*\[aq]\fP is used as a fallback.
  67 In the FreeBSD, NetBSD, and Solaris implementations of \fBiconv\fP, this
  68 condition cannot occur either, because a conversion to \fB\[aq]?\[aq]\fP is
  69 used as a fallback.
  70 When this condition is met, the \fBiconv\fP function sets \fBerrno\fP to
  71 \fBEILSEQ\fP and returns (size_t)(\-1).
  72 \fI*inbuf\fP is left pointing to the beginning of the unconvertible multibyte
  73 sequence.
  74 .PP
  75 5. The output buffer has no more room for the next converted character. In
  76 this case it sets \fBerrno\fP to \fBE2BIG\fP and returns (size_t)(\-1).
  77 .PP
  78 A different case is when \fIinbuf\fP is NULL or \fI*inbuf\fP is NULL, but
  79 \fIoutbuf\fP is not NULL and \fI*outbuf\fP is not NULL. In this case, the
  80 \fBiconv\fP function attempts to set \fIcd\fP's conversion state to the
  81 initial state and store a corresponding shift sequence at \fI*outbuf\fP.
  82 At most \fI*outbytesleft\fP bytes, starting at \fI*outbuf\fP, will be written.
  83 If the output buffer has no more room for this reset sequence, it sets
  84 \fBerrno\fP to \fBE2BIG\fP and returns (size_t)(\-1). Otherwise it increments
  85 \fI*outbuf\fP and decrements \fI*outbytesleft\fP by the number of bytes
  86 written.
  87 .PP
  88 A third case is when \fIinbuf\fP is NULL or \fI*inbuf\fP is NULL, and
  89 \fIoutbuf\fP is NULL or \fI*outbuf\fP is NULL. In this case, the \fBiconv\fP
  90 function sets \fIcd\fP's conversion state to the initial state.
  91 .SH "RETURN VALUE"
  92 The \fBiconv\fP function returns the number of characters converted in a
  93 non-reversible way during this call; reversible conversions are not counted.
  94 In case of error, it sets \fBerrno\fP and returns (size_t)(\-1).
  95 .SH ERRORS
  96 The following errors can occur, among others:
  97 .TP
  98 .B E2BIG
  99 There is not sufficient room at \fI*outbuf\fP.
 100 .TP
 101 .B EILSEQ
 102 An invalid multibyte sequence has been encountered in the input.
 103 .TP
 104 .B EINVAL
 105 An incomplete multibyte sequence has been encountered in the input.
 106 .SH "CONFORMING TO"
 107 POSIX:2001
 108 .SH "SEE ALSO"
 109 .BR iconv_open (3),
 110 .BR iconvctl (3)
 111 .BR iconv_close (3)