1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" References consulted:
.\" GNU glibc-2 source code and manual
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
.\"
.\" 2000-06-30 correction by Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
.\" 2000-11-15 aeb, fixed prototype
.\"
.\" Traducido por Miguel Pérez Ibars <mpi79470@alu.um.es> el 6-agosto-2004
.\"
.TH ICONV 3 "15 noviembre 2001" "GNU" "Manual del Programador de Linux"
.SH NOMBRE
iconv \- realiza la conversión del conjunto de caracteres
.SH SINOPSIS
.nf
.B #include <iconv.h>
.sp
.BI "size_t iconv(iconv_t " cd ,
.BI " char **" inbuf ", size_t *" inbytesleft ,
.BI " char **" outbuf ", size_t *" outbytesleft );
.fi
.SH DESCRIPCIÓN
El argumento \fIcd\fP debe ser un descriptor de conversión creado mediante
la función \fBiconv_open\fP.
.PP
El principal caso se da cuando \fIinbuf\fP es distinto de NULL y \fI*inbuf\fP
es distinto de NULL.
En este caso, la función \fBiconv\fP convierte la secuencia multibyte
que comienza en \fI*inbuf\fP en una secuencia multibyte que comenzará en \fI*outbuf\fP.
Como mucho se leerán \fI*inbytesleft\fP bytes, comenzando en \fI*inbuf\fP.
Como mucho se escribirán \fI*outbytesleft\fP bytes, comenzando en \fI*outbuf\fP.
.PP
La función \fBiconv\fP convierte un carácter multibyte a la vez, y para cada
conversión individual incrementa \fI*inbuf\fP y decrementa
\fI*inbytesleft\fP con el número de bytes de entrada convertidos, incrementa
\fI*outbuf\fP y decrementa \fI*outbytesleft\fP con el número de bytes de salida
convertidos, y actualiza el estado de la conversión contenido en \fIcd\fP.
La conversión puede detenerse por cuatro motivos:
.PP
1. Se encontró una secuencia multibyte inválida en la entrada. En este caso
se asigna a \fBerrno\fP el valor \fBEILSEQ\fP y se devuelve (size_t)(-1). \fI*inbuf\fP
se deja apuntando al principio de la secuencia multibyte inválida.
.PP
2. La secuencia de bytes de entrada ha sido totalmente convertida, esto es, \fI*inbytesleft\fP
ha llegado a 0. En este caso \fBiconv\fP devuelve el número de
conversiones no recuperables realizadas durante esta llamada.
.PP
3. Se encontró una secuencia multibyte incompleta en la entrada, y la secuencia de
bytes de entrada termina después de ella. En este caso se asigna a \fBerrno\fP el valor
\fBEINVAL\fP y se devuelve (size_t)(-1). \fI*inbuf\fP se deja apuntando al
principio de la secuencia multibyte incompleta.
.PP
4. El buffer de salida no tiene suficiente espacio para el siguiente carácter
convertido. En este caso se asigna a \fBerrno\fP el valor \fBE2BIG\fP y se devuelve (size_t)(-1).
.PP
Un caso diferente es cuando \fIinbuf\fP es NULL o \fI*inbuf\fP es NULL, pero
\fIoutbuf\fP no es NULL y \fI*outbuf\fP no es NULL. En este caso, la función
\fBiconv\fP intenta poner el estado de conversión de \fIcd\fP en el estado inicial
y almacenar una secuencia de cambios correspondiente en \fI*outbuf\fP.
Como mucho se ecribirán \fI*outbytesleft\fP bytes, comenzando en \fI*outbuf\fP.
Si el buffer de salida se queda sin espacio para esta secuencia de reinicio, la función asigna a
\fBerrno\fP el valor \fBE2BIG\fP y devuelve (size_t)(-1). En otro caso incrementa
\fI*outbuf\fP y decrementa \fI*outbytesleft\fP con el número de bytes escritos.
.PP
Un tercer caso es cuando \fIinbuf\fP es NULL o \fI*inbuf\fP es NULL, y
\fIoutbuf\fP es NULL o \fI*outbuf\fP es NULL. En este caso, la función \fBiconv\fP
pone el estado de conversión de \fIcd\fP en el estado inicial.
.SH "VALOR DEVUELTO"
La función \fBiconv\fP devuelve el número de caracteres convertidos de
manera no-recuperable durante la llamada; las conversiones recuperables no se cuentan.
En caso de error, modifica \fBerrno\fP con un valor apropiado y devuelve (size_t)(-1).
.SH ERRORES
Pueden ocurrir los siguientes errores, entre otros:
.TP
.B E2BIG
No hay suficiente espacio en \fI*outbuf\fP.
.TP
.B EILSEQ
Se encontró una secuencia multibyte inválida a la entrada.
.TP
.B EINVAL
Se encontró una secuencia multibyte incompleta a la entrada.
.SH "CONFORME A"
UNIX98
.SH "VÉASE TAMBIÉN"
.BR iconv_open (3),
.BR iconv_close (3)
|
