(split) Import translated manuals from JM CVS Repository.

[linuxjm/LDP_man-pages.git] / draft / man3 / iconv.3

.\" 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
.\"
.\" Japanese Version Copyright (c) 2000 Yuichi SATO
.\"         all rights reserved.
.\" Translated 2000-07-11, Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
.\" Updated 2008-09-14, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.09
.\"
.\"WORD:        conversion      ÊÑ´¹
.\"WORD:        descriptor      ¥Ç¥£¥¹¥¯¥ê¥×¥¿¡¼
.\"WORD:        sequence        ʸ»úÎó
.\"WORD:        
.\"
.TH ICONV 3 2008-09-08 "GNU" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O iconv \- perform character set conversion
iconv \- ʸ»ú¥»¥Ã¥ÈÊÑ´¹¤ò¹Ô¤¦
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.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
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O The argument \fIcd\fP must be a conversion descriptor created using the
.\"O function
.\"O .BR iconv_open (3).
°ú¤­¿ô \fIcd\fP ¤Ï¡¢´Ø¿ô
.BR iconv_open (3)
¤ò»È¤Ã¤ÆÀ¸À®¤µ¤ì¤ë
ÊÑ´¹¥Ç¥£¥¹¥¯¥ê¥×¥¿¡¼¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.PP
.\"O The main case is when \fIinbuf\fP is not NULL and \fI*inbuf\fP is not NULL.
.\"O In this case, the
.\"O .BR iconv ()
.\"O function converts the multibyte sequence
.\"O starting at \fI*inbuf\fP to a multibyte sequence starting at \fI*outbuf\fP.
.\"O At most \fI*inbytesleft\fP bytes, starting at \fI*inbuf\fP, will be read.
.\"O At most \fI*outbytesleft\fP bytes, starting at \fI*outbuf\fP, will be written.
¼ç¤Ë»È¤ï¤ì¤ë¤Î¤Ï¡¢
¡Ö\fIinbuf\fP ¤¬ NULL ¤Ç¤Ê¤¯¡¢¤«¤Ä \fI*inbuf\fP ¤¬ NULL ¤Ç¤Ê¤¤¡×
¤È¤¤¤¦¾ì¹ç¤Ç¤¢¤ë¡£
¤³¤Î¾ì¹ç¡¢
.BR iconv ()
´Ø¿ô¤Ï¡¢
\fI*inbuf\fP ¤Ç»Ï¤Þ¤ë¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»úÎó¤ò
\fI*outbuf\fP ¤Ç»Ï¤Þ¤ë¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»úÎó¤ËÊÑ´¹¤¹¤ë¡£
\fI*inbuf\fP ¤òÀèƬ¤È¤·¤ÆºÇÂç \fI*inbytesleft\fP ¥Ð¥¤¥È¤¬Æɤ߹þ¤Þ¤ì¡¢
\fI*outbuf\fP ¤òÀèƬ¤È¤·¤ÆºÇÂç \fI*outbytesleft\fP ¥Ð¥¤¥È¤¬½ñ¤­½Ð¤µ¤ì¤ë¡£
.PP
.\"O The
.\"O .BR iconv ()
.\"O function converts one multibyte character at a time, and for
.\"O each character conversion it increments \fI*inbuf\fP and decrements
.\"O \fI*inbytesleft\fP by the number of converted input bytes, it increments
.\"O \fI*outbuf\fP and decrements \fI*outbytesptr\fP by the number of converted
.\"O output bytes, and it updates the conversion state contained in \fIcd\fP.
.\"O If the character encoding of the input is stateful, the
.\"O .BR iconv ()
.\"O function can also convert a sequence of input bytes
.\"O to an update to the conversion state without producing any output bytes;
.\"O such input is called a \fIshift sequence\fP.
.\"O The conversion can stop for four reasons:
.BR iconv ()
´Ø¿ô¤Ï 1 ÅÙ¤Ë 1 ¤Ä¤Î¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»ú¤òÊÑ´¹¤¹¤ë¡£
¤½¤·¤Æ¡¢³Æʸ»úÊÑ´¹Ëè¤Ë¡¢ÊÑ´¹¤µ¤ì¤¿ÆþÎϥХ¤¥È¤Î¿ô¤À¤±
\fI*inbuf\fP ¤òÁý²Ã¤µ¤»¡¢\fI*inbytesleft\fP ¤ò¸º¾¯¤µ¤»¤ë¡£
¤Þ¤¿¡¢ÊÑ´¹¤µ¤ì¤¿½ÐÎϥХ¤¥È¤Î¿ô¤À¤±
\fI*outbuf\fP ¤òÁý²Ã¤µ¤»¡¢\fI*outbytesleft\fP ¤ò¸º¾¯¤µ¤»¤ë¡£
¤µ¤é¤Ë¡¢\fIcd\fP ¤Ë´Þ¤Þ¤ì¤ëÊÑ´¹¾õÂÖ¤ò¹¹¿·¤¹¤ë¡£
ÆþÎϤÎʸ»ú¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤¬¤¬¾õÂÖ¤ò»ý¤Ä¾ì¹ç¡¢
.BR iconv ()
´Ø¿ô¤ÏÆþÎϥХ¤¥È¤ÎÎó¤ËÂФ·¤ÆÊÑ´¹¤Ë¤âÂбþ¤·¤Æ¤ª¤ê¡¢
¥Ð¥¤¥È½ÐÎϤòȼ¤ï¤º¤ËÊÑ´¹¾õÂÖ¤ò¹¹¿·¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
ÊÑ´¹¤Ï¡¢¼¡¤Î 4 ¤Ä¤Î¾ì¹ç¤ËÄä»ß¤¹¤ë¡£
.PP
.\"O 1. An invalid multibyte sequence is encountered in the input.
.\"O In this case
.\"O it sets \fIerrno\fP to \fBEILSEQ\fP and returns
.\"O .IR (size_t)\ \-1 .
.\"O \fI*inbuf\fP
.\"O is left pointing to the beginning of the invalid multibyte sequence.
1. ÆþÎϤË̵¸ú¤Ê¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»úÎ󤬤¢¤Ã¤¿¾ì¹ç¡£
¤³¤Î¾ì¹ç¡¢´Ø¿ô¤Ï \fIerrno\fP ¤ò \fBEILSEQ\fP ¤ËÀßÄꤷ¡¢
.I (size_t)\ \-1
¤òÊÖ¤¹¡£
\fI*inbuf\fP ¤Ï¡¢Ìµ¸ú¤Ê¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»úÎó¤ÎÀèƬ¤ò»Ø¤·¤¿¤Þ¤Þ¤Ë¤Ê¤ë¡£
.PP
.\"O 2. The input byte sequence has been entirely converted,
.\"O that is, \fI*inbytesleft\fP has gone down to 0.
.\"O In this case
.\"O .BR iconv ()
.\"O returns the number of
.\"O nonreversible conversions performed during this call.
2. ÆþÎϥХ¤¥Èʸ»úÎ󤬴°Á´¤ËÊÑ´¹¤µ¤ì¡¢\fI*inbytesleft\fP ¤¬ 0 ¤Ë¤Ê¤Ã¤¿¾ì¹ç¡£
¤³¤Î¾ì¹ç¡¢
.BR iconv ()
¤Ï¡¢¸Æ½Ð¤·¤Î´Ö¤ËÈó²ÄµÕÊÑ´¹¤¬¹Ô¤ï¤ì¤¿²ó¿ô¤òÊÖ¤¹¡£
.PP
.\"O 3. An incomplete multibyte sequence is encountered in the input, and the
.\"O input byte sequence terminates after it.
.\"O In this case it sets \fIerrno\fP to
.\"O \fBEINVAL\fP and returns
.\"O .IR (size_t)\ \-1 .
.\"O \fI*inbuf\fP is left pointing to the
.\"O beginning of the incomplete multibyte sequence.
3. ÆþÎϤËÉÔ´°Á´¤Ê¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»úÎ󤬤¢¤ê¡¢
ÆþÎϥХ¤¥Èʸ»úÎ󤬤½¤Î¸å¤Ç½ªÎ»¤·¤Æ¤¤¤ë¾ì¹ç¡£
¤³¤Î¾ì¹ç¡¢´Ø¿ô¤Ï¡¢\fIerrno\fP ¤ò \fBEINVAL\fP ¤ËÀßÄꤷ¡¢
.I (size_t)\ \-1
¤òÊÖ¤¹¡£
\fI*inbuf\fP ¤Ï¡¢ÉÔ´°Á´¤Ê¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»úÎó¤ÎÀèƬ¤ò»Ø¤·¤¿¤Þ¤Þ¤Ë¤µ¤ì¤ë¡£
.PP
.\"O 4. The output buffer has no more room for the next converted character.
.\"O In this case it sets \fIerrno\fP to \fBE2BIG\fP and returns
.\"O .IR (size_t)\ \-1 .
4. ½ÐÎϥХåե¡¡¼¤Ë¼¡¤ÎÊÑ´¹¤µ¤ì¤¿Ê¸»úÎó¤Î¤¿¤á¤Î¶õ¤­¤¬¤Ê¤¤¾ì¹ç¡£
¤³¤Î¾ì¹ç¡¢\fIerrno\fP ¤¬ \fBE2BIG\fP ¤ËÀßÄꤵ¤ì¡¢
.I (size_t)\ \-1
¤¬ÊÖ¤µ¤ì¤ë¡£
.PP
.\"O A different case is when \fIinbuf\fP is NULL or \fI*inbuf\fP is NULL, but
.\"O \fIoutbuf\fP is not NULL and \fI*outbuf\fP is not NULL.
.\"O In this case, the
.\"O .BR iconv ()
.\"O function attempts to set \fIcd\fP's conversion state to the
.\"O initial state and store a corresponding shift sequence at \fI*outbuf\fP.
.\"O At most \fI*outbytesleft\fP bytes, starting at \fI*outbuf\fP, will be written.
.\"O If the output buffer has no more room for this reset sequence, it sets
.\"O \fIerrno\fP to \fBE2BIG\fP and returns
.\"O .IR (size_t)\ \-1 .
.\"O Otherwise it increments
.\"O \fI*outbuf\fP and decrements \fI*outbytesptr\fP by the number of bytes
.\"O written.
Ê̤Υ±¡¼¥¹¤È¤·¤Æ¤Ï¡¢
¡Ö\fIinbuf\fP ¤¬ NULL¡¢¤Þ¤¿¤Ï \fI*inbuf\fP ¤¬ NULL ¤Ç¤¢¤ë¡£
¤·¤«¤·¡¢\fIoutbuf\fP ¤¬ NULL ¤Ç¤Ê¤¯¡¢¤«¤Ä \fI*outbuf\fP ¤¬ NULL ¤Ç¤Ê¤¤¡×
¤È¤¤¤¦¾ì¹ç¤¬¤¢¤ë¡£
¤³¤Î¾ì¹ç¡¢
.BR iconv ()
´Ø¿ô¤Ï¡¢\fIcd\fP ¤ÎÊÑ´¹¾õÂÖ¤ò½é´ü¾õÂ֤ˤ·¤Æ¡¢
Âбþ¤¹¤ë¥·¥Õ¥Èʸ»úÎó¤ò \fI*outbuf\fP ¤ËÊݸ¤·¤è¤¦¤È¤¹¤ë¡£
ºÇÂç \fI*outbytesleft\fP ¥Ð¥¤¥È¤¬¡¢\fI*outbuf\fP ¤ò»Ï¤á¤È¤·¤Æ½ñ¤­½Ð¤µ¤ì¤ë¡£
¤³¤Î¥ê¥»¥Ã¥È¤µ¤ì¤¿Ê¸»úÎó¤ËÂФ·¤Æ¡¢½ÐÎϥХåե¡¡¼¤Ë¶õ¤­¤¬¤Ê¤¤¾ì¹ç¡¢
¤³¤Î´Ø¿ô¤Ï \fIerrno\fP ¤ò \fBE2BIG\fP ¤ËÀßÄꤷ¡¢
.I (size_t)\ \-1
¤òÊÖ¤¹¡£
¤½¤ì°Ê³°¤Î¾ì¹ç¡¢¤³¤Î´Ø¿ô¤Ï¡¢½ñ¤­¹þ¤Þ¤ì¤¿¥Ð¥¤¥È¤Î¿ô¤À¤±
\fI*outbuf\fP ¤òÁý²Ã¤µ¤»¡¢\fI*outbytesleft\fP ¤ò¸º¾¯¤µ¤»¤ë¡£
.PP
.\"O A third state is when \fIinbuf\fP is NULL or \fI*inbuf\fP is NULL, and
.\"O \fIoutbuf\fP is NULL or \fI*outbuf\fP is NULL.
.\"O In this case, the
.\"O .BR iconv ()
.\"O function sets \fIcd\fP's conversion state to the initial state.
3 ÈÖÌܤΥ±¡¼¥¹¤·¤Æ¤Ï¡¢
¡Ö\fIinbuf\fP ¤¬ NULL¡¢¤Þ¤¿¤Ï \fI*inbuf\fP ¤¬ NULL ¤Ç¤¢¤ë¡£
¤«¤Ä¡¢\fIoutbuf\fP ¤¬ NULL¡¢¤Þ¤¿¤Ï \fI*outbuf\fP ¤¬ NULL ¤Ç¤¢¤ë¡×
¤È¤¤¤¦¾ì¹ç¤¬¤¢¤ë¡£
¤³¤Î¾ì¹ç¡¢
.BR iconv ()
´Ø¿ô¤Ï¡¢\fIcd\fP ¤ÎÊÑ´¹¾õÂÖ¤ò½é´ü¾õÂ֤ˤ¹¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O The
.\"O .BR iconv ()
.\"O function returns the number of characters converted in a
.\"O nonreversible way during this call; reversible conversions are not counted.
.\"O In case of error, it sets \fIerrno\fP and returns
.\"O .IR (size_t)\ \-1 .
.BR iconv ()
´Ø¿ô¤Ï¡¢¸Æ½Ð¤·¤Î´Ö¤ËÈó²ÄµÕ¤ÊÊýË¡¤ÇÊÑ´¹¤µ¤ì¤¿Ê¸»ú¿ô¤òÊÖ¤¹¡£
¤Ä¤Þ¤ê¡¢²ÄµÕÊÑ´¹¤Ï¥«¥¦¥ó¥È¤µ¤ì¤Ê¤¤¡£
¥¨¥é¡¼¤Î¾ì¹ç¡¢¤³¤Î´Ø¿ô¤Ï \fIerrno\fP ¤òÀßÄꤷ¡¢
.I (size_t)\ \-1
¤òÊÖ¤¹¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.\"O The following errors can occur, among others:
¾¤Î¤¤¤í¤¤¤í¤Ê¥¨¥é¡¼¤Î¤¦¤Á¤«¤é¡¢°Ê²¼¤Î¥¨¥é¡¼¤¬µ¯¤³¤ê¤¦¤ë¡£
.TP
.B E2BIG
.\"O There is not sufficient room at \fI*outbuf\fP.
\fI*outbuf\fP ¤Ë½½Ê¬¤Ê¶õ¤­¤¬¤Ê¤¤¡£
.TP
.B EILSEQ
.\"O An invalid multibyte sequence has been encountered in the input.
ÆþÎϤË̵¸ú¤Ê¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»úÎ󤬤¢¤Ã¤¿¡£
.TP
.B EINVAL
.\"O An incomplete multibyte sequence has been encountered in the input.
ÆþÎϤËÉÔ´°Á´¤Ê¥Þ¥ë¥Á¥Ð¥¤¥Èʸ»úÎ󤬤¢¤Ã¤¿¡£
.\"O .SH VERSIONS
.SH ¥Ð¡¼¥¸¥ç¥ó
.\"O This function is available in glibc since version 2.1.
¤³¤Î´Ø¿ô¤Ï¥Ð¡¼¥¸¥ç¥ó 2.1 °Ê¹ß¤Î glibc ¤ÇÍøÍѲÄǽ¤Ç¤¢¤ë¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
POSIX.1-2001.
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR iconv_close (3),
.BR iconv_open (3)