release/man3/wcrtomb.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 http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .\" About this Japanese page, please contact to JM Project <JM@linux.or.jp>
  15 .\" Translated Mon Oct 25 22:55:40 JST 1999
  16 .\"           by FUJIWARA Teruyoshi <fujiwara@linux.or.jp>
  17 .\"
  18 .TH WCRTOMB 3  2011-09-28 "GNU" "Linux Programmer's Manual"
  19 .SH 名前
  20 wcrtomb \- ワイド文字 1 つをマルチバイト列に変換する
  21 .SH 書式
  22 .nf
  23 .B #include <wchar.h>
  24 .sp
  25 .BI "size_t wcrtomb(char *" s ", wchar_t " wc ", mbstate_t *" ps );
  26 .fi
  27 .SH 説明
  28 この関数が主に使われるのは、\fIs\fP が NULL でなく、
  29 \fIwc\fP が NULL ワイド文字 (L\(aq\\0\(aq) でない場合である。
  30 この場合には、
  31 .BR wcrtomb ()
  32 関数はワイド文字 \fIwc\fP をマルチバイト表
  33 現に変換し、\fIs\fP が指す char 型の配列にこれを格納する。この関数は
  34 シフト状態 \fI*ps\fP を更新し、出力されたマルチバイト表現の長さ、すな
  35 わち \fIs\fP に書き込まれたバイト数を返す。
  36 .PP
  37 別のケースとしては、\fIs\fP は NULL でないが
  38 \fIwc\fP が NULL ワイド文字 (L\(aq\\0\(aq) のことがある。
  39 この場合の
  40 .BR wcrtomb ()
  41 関数は、\fI*ps\fP を初期状態に戻すのに必
  42 要なシフトシーケンスを \fIs\fP が指す char 型配列に格納し、その後に \(aq\\0\(aq
  43 を格納する。この関数はシフト状態 \fI*ps\fP を更新し(つまり初期状態に戻
  44 し)、シフトシーケンスの長さに 1 を加えた値を返す。この値は \fIs\fP に
  45 書き込まれたバイト数である。
  46 .PP
  47 三番目のケースは、\fIs\fP が NULL の時である。
  48 この場合には \fIwc\fP は無視され、関数の実際の動きとしては
  49
  50     wcrtomb(buf, L\(aq\\0\(aq, ps)
  51
  52 が返される。ここで、
  53 .I buf
  54 は内部的な無名バッファである。
  55
  56 .PP
  57 以上のいずれの場合も、\fIps\fP が NULL ポインタならばシフト状態は用い
  58 られず、
  59 .BR wcrtomb ()
  60 関数だけが知っている静的な匿名の状態が使われる。
  61 .SH 返り値
  62 .BR wcrtomb ()
  63 関数は、\fIs\fP が指すバイト列に書き込まれたバイト数、あ
  64 るいは書き込まれたであろうバイト数を返す。\fIwc\fP を(現在のロケールに
  65 従って)マルチバイト列で表現できなければ、
  66 .I (size_t)\ \-1
  67 が返され、 \fIerrno\fP に \fBEILSEQ\fP が設定される。
  68 .SH 準拠
  69 C99.
  70 .SH 注意
  71 .BR wcrtomb ()
  72 の動作は、現在のロケールの
  73 .B LC_CTYPE
  74 カテゴリに依存する。
  75 .PP
  76 \fIps\fP に NULL を渡した際の動作はマルチスレッドセーフでない。
  77 .SH 関連項目
  78 .BR wcsrtombs (3)