draft/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 .\"*******************************************************************
  15 .\"
  16 .\" This file was generated with po4a. Translate the source file.
  17 .\"
  18 .\"*******************************************************************
  19 .TH WCRTOMB 3 2011\-09\-28 GNU "Linux Programmer's Manual"
  20 .SH 名前
  21 wcrtomb \- ワイド文字 1 つをマルチバイト列に変換する
  22 .SH 書式
  23 .nf
  24 \fB#include <wchar.h>\fP
  25 .sp
  26 \fBsize_t wcrtomb(char *\fP\fIs\fP\fB, wchar_t \fP\fIwc\fP\fB, mbstate_t *\fP\fIps\fP\fB);\fP
  27 .fi
  28 .SH 説明
  29 この関数が主に使われるのは、\fIs\fP が NULL でなく、 \fIwc\fP が NULL ワイド文字 (L\(aq\e0\(aq) でない場合である。
  30 この場合には、 \fBwcrtomb\fP()  関数はワイド文字 \fIwc\fP をマルチバイト表 現に変換し、\fIs\fP が指す char
  31 型の配列にこれを格納する。この関数は シフト状態 \fI*ps\fP を更新し、出力されたマルチバイト表現の長さ、すな わち \fIs\fP
  32 に書き込まれたバイト数を返す。
  33 .PP
  34 別のケースとしては、\fIs\fP は NULL でないが \fIwc\fP が NULL ワイド文字 (L\(aq\e0\(aq) のことがある。 この場合の
  35 \fBwcrtomb\fP()  関数は、\fI*ps\fP を初期状態に戻すのに必 要なシフトシーケンスを \fIs\fP が指す char 型配列に格納し、その後に
  36 \(aq\e0\(aq を格納する。この関数はシフト状態 \fI*ps\fP を更新し(つまり初期状態に戻 し)、シフトシーケンスの長さに 1
  37 を加えた値を返す。この値は \fIs\fP に 書き込まれたバイト数である。
  38 .PP
  39 三番目のケースは、\fIs\fP が NULL の時である。 この場合には \fIwc\fP は無視され、関数の実際の動きとしては
  40
  41     wcrtomb(buf, L\(aq\e0\(aq, ps)
  42
  43 が返される。ここで、 \fIbuf\fP は内部的な無名バッファである。
  44 .PP
  45 以上のいずれの場合も、\fIps\fP が NULL ポインタならばシフト状態は用い られず、 \fBwcrtomb\fP()
  46 関数だけが知っている静的な匿名の状態が使われる。
  47 .SH 返り値
  48 \fBwcrtomb\fP()  関数は、\fIs\fP が指すバイト列に書き込まれたバイト数、あ るいは書き込まれたであろうバイト数を返す。\fIwc\fP
  49 を(現在のロケールに 従って)マルチバイト列で表現できなければ、 \fI(size_t)\ \-1\fP が返され、 \fIerrno\fP に \fBEILSEQ\fP
  50 が設定される。
  51 .SH 準拠
  52 C99.
  53 .SH 注意
  54 \fBwcrtomb\fP()  の動作は、現在のロケールの \fBLC_CTYPE\fP カテゴリに依存する。
  55 .PP
  56 \fIps\fP に NULL を渡した際の動作はマルチスレッドセーフでない。
  57 .SH 関連項目
  58 \fBwcsrtombs\fP(3)