draft/man3/mbrtowc.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   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 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification
  12 .\"      http://www.UNIX-systems.org/online.html
  13 .\"   ISO/IEC 9899:1999
  14 .\"
  15 .\" Japanese Version Copyright (c) 1999 HANATAKA Shinya
  16 .\"         all rights reserved.
  17 .\" Translated Tue Jan 11 00:56:16 JST 2000
  18 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  19 .\" Updated Thu Dec 13 JST 2001 by Kentaro Shirakata <argrath@ub32.org>
  20 .\"
  21 .TH MBRTOWC 3  2011-09-28 "GNU" "Linux Programmer's Manual"
  22 .\"O .SH NAME
  23 .SH Ì¾Á°
  24 .\"O mbrtowc \- convert a multibyte sequence to a wide character
  25 mbrtowc \- ¥Þ¥ë¥Á¥Ð¥¤¥ÈÎó¤ò¥ï¥¤¥ÉÊ¸»ú¤ËÊÑ´¹¤¹¤ë
  26 .\"O .SH SYNOPSIS
  27 .SH ½ñ¼°
  28 .nf
  29 .B #include <wchar.h>
  30 .sp
  31 .BI "size_t mbrtowc(wchar_t *" pwc ", const char *" s ", size_t " n \
  32 ", mbstate_t *" ps );
  33 .fi
  34 .\"O .SH DESCRIPTION
  35 .SH ÀâÌÀ
  36 .\"O The main case for this function is when \fIs\fP is not NULL and \fIpwc\fP is
  37 .\"O not NULL.
  38 .\"O In this case, the
  39 .\"O .BR mbrtowc ()
  40 .\"O function inspects at most \fIn\fP
  41 .\"O bytes of the multibyte string starting at \fIs\fP, extracts the next complete
  42 .\"O multibyte character, converts it to a wide character and stores it at
  43 .\"O \fI*pwc\fP.
  44 .\"O It updates the shift state \fI*ps\fP.
  45 .\"O If the converted wide
  46 .\"O- character is not L\(aq\\0\(aq, it returns the number of bytes that were consumed
  47 .\"O+ character is not L\(aq\\0\(aq (the null wide character),
  48 .\"O+ it returns the number of bytes that were consumed
  49 .\"O from \fIs\fP.
  50 .\"O If the converted wide character is L\(aq\\0\(aq, it resets the shift
  51 .\"O state \fI*ps\fP to the initial state and returns 0.
  52 ¤³¤Î´Ø¿ô¤¬ÍÑ¤¤¤é¤ì¤ë¾ì¹ç¡¢ÄÌ¾ï \fIs\fP ¤¬ NULL ¤Ç¤Ê¤¯ \fIpwc\fP ¤â NULL ¤Ç
  53 ¤Ê¤¤¡£¤³¤Î¾ì¹ç¤Ï¡¢
  54 .BR mbrtowc ()
  55 ´Ø¿ô¤Ï \fIs\fP ¤«¤é»Ï¤Þ¤ëºÇÂç \fIn\fP ¥Ð¥¤¥È¤Î
  56 ¥Þ¥ë¥Á¥Ð¥¤¥ÈÊ¸»ú¤ò¸¡ºº¤·¤Æ¡¢¼¡¤Î´°Á´¤Ê¥Þ¥ë¥Á¥Ð¥¤¥ÈÊ¸»úÎó¤ò¼è¤ê½Ð¤·¡¢
  57 ¤½¤ì¤ò¥ï¥¤¥ÉÊ¸»ú¤ËÊÑ´¹¤·¤Æ \fI*pwc\fP ¤Ë³ÊÇ¼¤¹¤ë¡£
  58 Æ±»þ¤Ë¥·¥Õ¥È¾õÂÖ \fI*ps\fP ¤ò¹¹¿·¤¹¤ë¡£
  59 ÊÑ´¹¤·¤¿¥ï¥¤¥ÉÊ¸»ú¤¬ L\(aq\\0\(aq (NULL ¥ï¥¤¥ÉÊ¸»ú) ¤Ç¤Ê¤±¤ì¤Ð¡¢
  60 \fIs\fP ¤«¤é¾ÃÈñ¤¹¤ë¥Ð¥¤¥È¿ô¤òÊÖ¤¹¡£
  61 ÊÑ´¹¤·¤¿¥ï¥¤¥ÉÊ¸»ú¤¬ L\(aq\\0\(aq ¤Î¾ì¹ç¤Ë¤Ï¥·¥Õ¥È¾õÂÖ \fI*ps\fP ¤ò
  62 ½é´ü¾õÂÖ¤ËÌá¤·¤Æ 0 ¤òÊÖ¤¹¡£
  63 .PP
  64 .\"O If the \fIn\fP bytes starting at \fIs\fP do not contain a complete multibyte
  65 .\"O character,
  66 .\"O .BR mbrtowc ()
  67 .\"O returns \fI(size_t)\ \-2\fP.
  68 .\"O This can happen even if
  69 .\"O \fIn\fP >= \fIMB_CUR_MAX\fP, if the multibyte string contains redundant shift
  70 .\"O sequences.
  71 \fIs\fP ¤«¤é»Ï¤Þ¤ë \fIn\fP ¥Ð¥¤¥È¤¬´°Á´¤Ê¥Þ¥ë¥Á¥Ð¥¤¥ÈÊ¸»ú¤ò´Þ¤ó¤Ç¤¤¤Ê¤¤
  72 ¾ì¹ç¤Ë¤Ï¡¢
  73 .BR mbrtowc ()
  74 ¤Ï \fI(size_t)\ \-2\fP ¤òÊÖ¤¹¡£
  75 ¥Þ¥ë¥Á¥Ð¥¤¥ÈÊ¸»úÎó¤Ë¾éÄ¹¤Ê¥·¥Õ¥È¥·¡¼¥±¥ó¥¹¤¬´Þ¤Þ¤ì¤Æ¤¤¤ë¤È¡¢
  76 \fIn\fP >= \fIMB_CUR_MAX\fP ¤Î»þ¤Ë¤â¤³¤Î¤è¤¦¤Ê¤³¤È¤¬µ¯¤³¤ê¤¨¤ë¡£
  77 .PP
  78 .\"O If the multibyte string starting at \fIs\fP contains an invalid multibyte
  79 .\"O sequence before the next complete character,
  80 .\"O .BR mbrtowc ()
  81 .\"O returns
  82 .\"O \fI(size_t)\ \-1\fP and sets \fIerrno\fP to \fBEILSEQ\fP.
  83 .\"O In this case,
  84 .\"O the effects on \fI*ps\fP are undefined.
  85 \fIs\fP ¤«¤é»Ï¤Þ¤ë¥Þ¥ë¥Á¥Ð¥¤¥ÈÊ¸»úÎó¤¬¡¢¼¡¤Î´°Á´¤ÊÊ¸»ú¤ÎÁ°¤Ë
  86 ÉÔÀµ¤Ê¥Þ¥ë¥Á¥Ð¥¤¥ÈÎó¤ò´Þ¤ó¤Ç¤¤¤ë¾ì¹ç¤Ë¤Ï¡¢
  87 .BR mbrtowc ()
  88 ¤Ï
  89 \fI(size_t)\ \-1\fP ¤òÊÖ¤·¡¢\fIerrno\fP ¤Ë \fBEILSEQ\fP ¤òÀßÄê¤¹¤ë¡£
  90 ¤³¤Î¾ì¹ç¤Ï \fI*ps\fP ¤Ø¤Î±Æ¶Á¤ÏÌ¤ÄêµÁ¤Ç¤¢¤ë¡£
  91 .PP
  92 .\"O A different case is when \fIs\fP is not NULL but \fIpwc\fP is NULL.
  93 .\"O In this
  94 .\"O case the
  95 .\"O .BR mbrtowc ()
  96 .\"O function behaves as above, except that it does not
  97 .\"O store the converted wide character in memory.
  98 \fIs\fP ¤¬ NULL ¤Ç¤Ê¤¯ \fIpwc\fP ¤¬ NULL ¤Î¾ì¹ç¤Ï
  99 .BR mbrtowc ()
 100 ´Ø¿ô¤Ï
 101 ¾åµ¤ÈÆ±ÍÍ¤ËÆ°ºî¤¹¤ë¤¬¡¢ÊÑ´¹¤·¤¿¥ï¥¤¥ÉÊ¸»ú¤Ï¥á¥â¥ê¤Ë¤Ï½ñ¤¹þ¤Þ¤ì¤Ê¤¤¡£
 102 .PP
 103 .\"O A third case is when \fIs\fP is NULL.
 104 .\"O In this case, \fIpwc\fP and \fIn\fP are
 105 .\"O ignored.
 106 .\"O If the conversion state represented by \fI*ps\fP denotes an
 107 .\"O incomplete multibyte character conversion, the
 108 .\"O .BR mbrtowc ()
 109 .\"O function
 110 .\"O returns \fI(size_t)\ \-1\fP, sets \fIerrno\fP to \fBEILSEQ\fP, and
 111 .\"O leaves \fI*ps\fP in an undefined state.
 112 .\"O Otherwise, the
 113 .\"O .BR mbrtowc ()
 114 .\"O function
 115 puts \fI*ps\fP in the initial state and returns 0.
 116 »°ÈÖÌÜ¤Î¾ì¹ç¤È¤·¤Æ \fIs\fP ¤¬ NULL ¤Î¾ì¹ç¡¢ \fIpwc\fP ¤È \fIn\fP ¤Ï
 117 Ìµ»ë¤µ¤ì¤ë¡£
 118 \fI*ps\fP ¤¬É½¸½¤¹¤ëÊÑ´¹¾õÂÖ¤¬ÉÔ´°Á´¤Ê¥Þ¥ë¥Á¥Ð¥¤¥ÈÊ¸»úÊÑ´¹¤ò¼¨¤·¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢
 119 .BR mbrtowc ()
 120 ´Ø¿ô¤Ï \fI(size_t)\ \-1\fP ¤òÊÖ¤·¡¢
 121 \fIerrno\fP ¤Ë \fBEILSEQ\fP ¤ò¥»¥Ã¥È¤·¡¢
 122 \fI*ps\fP ¤ÏÌ¤ÄêµÁ¾õÂÖ¤Î¤Þ¤Þ¤Ë¤¹¤ë¡£
 123 ¤µ¤â¤Ê¤±¤ì¤Ð¡¢
 124 .BR mbrtowc ()
 125 ´Ø¿ô¤Ï \fI*ps\fP ¤ò½é´ü¾õÂÖ¤Ë¤·¤Æ 0 ¤òÊÖ¤¹¡£
 126 .PP
 127 .\"O In all of the above cases, if \fIps\fP is a NULL pointer, a static anonymous
 128 .\"O state only known to the mbrtowc function is used instead.
 129 ¾åµ¤ÎÁ´¤Æ¤Î¾ì¹ç¤Ë¤ª¤¤¤Æ¡¢\fIps\fP ¤¬ NULL ¥Ý¥¤¥ó¥¿¡¼¤Ê¤é¤ÐÂå¤ï¤ê¤Ë
 130 mbrtowc ´Ø¿ô¤Î¤ß¤¬»ÈÍÑ¤¹¤ëÀÅÅª¤ÇÌ¾Á°¤Î¤Ê¤¤¾õÂÖ¤¬»ÈÍÑ¤µ¤ì¤ë¡£
 131 .\"O Otherwise, \fI*ps\fP must be a valid \fImbstate_t\fP object.
 132 ¤µ¤â¤Ê¤±¤ì¤Ð¡¢\fI*ps\fP ¤ÏÍ¸ú¤Ê \fImbstate_t\fP ¥ª¥Ö¥¸¥§¥¯¥È¤Ç
 133 ¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
 134 .\"O An \fImbstate_t\fP object \fIa\fP can be initialized to the initial state
 135 .\"O by zeroing it, for example using
 136 \fImbstate_t\fP ¥ª¥Ö¥¸¥§¥¯¥È¤Ç¤¢¤ë \fIa\fP ¤Ï¥¼¥í¤ÇËä¤á¤ë¤³¤È¤Ë¤è¤Ã¤Æ
 137 ½é´ü¾õÂÖ¤Ë½é´ü²½¤Ç¤¤ë¡£°Ê²¼¤ËÎã¤ò¼¨¤¹¡£
 138 .sp
 139 .in +4n
 140 memset(&a, 0, sizeof(a));
 141 .in
 142 .\"O .SH "RETURN VALUE"
 143 .SH ÊÖ¤êÃÍ
 144 .\"O The
 145 .\"O .BR mbrtowc ()
 146 .\"O function returns the number of bytes parsed from the
 147 .\"O multibyte sequence starting at \fIs\fP, if a non-L\(aq\\0\(aq wide character
 148 .\"O was recognized.
 149 L\(aq\\0\(aq °Ê³°¤Î¥ï¥¤¥ÉÊ¸»ú¤òÇ§¼±¤·¤¿¾ì¹ç¤Ë¤Ï
 150 .BR mbrtowc ()
 151 ´Ø¿ô¤Ï \fIs\fP
 152 ¤«¤é»Ï¤Þ¤ë¥Þ¥ë¥Á¥Ð¥¤¥ÈÎó¤«¤é²òÀÏ¤·¤¿¥Ð¥¤¥È¿ô¤òÊÖ¤¹¡£
 153 .\"O It returns 0, if a L\(aq\\0\(aq wide character was recognized.
 154 .\"O It returns
 155 .\"O .I (size_t)\ \-1
 156 .\"O and sets \fIerrno\fP to \fBEILSEQ\fP, if an invalid multibyte sequence was
 157 .\"O encountered.
 158 .\"O It returns \fI(size_t)\ \-2\fP if it couldn't parse a complete multibyte
 159 .\"O character, meaning that \fIn\fP should be increased.
 160 L\(aq\\0\(aq ¥ï¥¤¥ÉÊ¸»ú¤òÇ§¼±¤·¤¿¾ì¹ç¤Ë¤Ï 0 ¤òÊÖ¤¹¡£
 161 ÉÔÀµ¤Ê¥Þ¥ë¥Á¥Ð¥¤¥ÈÎó¤ËÁø¶ø¤·¤¿¾ì¹ç¤Ë¤Ï
 162 .I (size_t)\ \-1
 163 ¤òÊÖ¤·¡¢
 164 \fIerrno\fP ¤Ë \fBEILSEQ\fP ¤òÀßÄê¤¹¤ë¡£´°Á´¤Ê¥Þ¥ë¥Á¥Ð¥¤¥ÈÊ¸»ú¤ò
 165 ²òÀÏ¤Ç¤¤Ê¤«¤Ã¤¿¾ì¹ç¤Ë¤Ï
 166 .I (size_t)\ \-2
 167 ¤òÊÖ¤· \fIn\fP ¤òÁý²Ã¤µ¤»¤ëÉ¬Í×¤¬¤¢¤ë¤³¤È¤ò¼¨¤¹¡£
 168 .\"O .SH "CONFORMING TO"
 169 .SH ½àµò
 170 C99.
 171 .\"O .SH NOTES
 172 .SH Ãí°Õ
 173 .\"O The behavior of
 174 .\"O .BR mbrtowc ()
 175 .\"O depends on the
 176 .\"O .B LC_CTYPE
 177 .\"O category of the
 178 .\"O current locale.
 179 .BR mbrtowc ()
 180 ¤ÎÆ°ºî¤Ï¸½ºß¤Î¥í¥±¡¼¥ë¤Î
 181 .B LC_CTYPE
 182 ¥«¥Æ¥´¥ê¤Ë°ÍÂ¸¤·¤Æ¤¤¤ë¡£
 183 .\"O .SH "SEE ALSO"
 184 .SH ´ØÏ¢¹àÌÜ
 185 .BR mbsrtowcs (3)