release/man3/wcrtomb.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .\"*******************************************************************
  17 .\"
  18 .\" This file was generated with po4a. Translate the source file.
  19 .\"
  20 .\"*******************************************************************
  21 .TH WCRTOMB 3 2011\-09\-28 GNU "Linux Programmer's Manual"
  22 .SH 名前
  23 wcrtomb \- ワイド文字 1 つをマルチバイト列に変換する
  24 .SH 書式
  25 .nf
  26 \fB#include <wchar.h>\fP
  27 .sp
  28 \fBsize_t wcrtomb(char *\fP\fIs\fP\fB, wchar_t \fP\fIwc\fP\fB, mbstate_t *\fP\fIps\fP\fB);\fP
  29 .fi
  30 .SH 説明
  31 この関数が主に使われるのは、\fIs\fP が NULL でなく、 \fIwc\fP が NULL ワイド文字 (L\(aq\e0\(aq) でない場合である。
  32 この場合には、 \fBwcrtomb\fP()  関数はワイド文字 \fIwc\fP をマルチバイト表 現に変換し、\fIs\fP が指す char
  33 型の配列にこれを格納する。この関数は シフト状態 \fI*ps\fP を更新し、出力されたマルチバイト表現の長さ、すな わち \fIs\fP
  34 に書き込まれたバイト数を返す。
  35 .PP
  36 別のケースとしては、\fIs\fP は NULL でないが \fIwc\fP が NULL ワイド文字 (L\(aq\e0\(aq) のことがある。 この場合の
  37 \fBwcrtomb\fP()  関数は、\fI*ps\fP を初期状態に戻すのに必 要なシフトシーケンスを \fIs\fP が指す char 型配列に格納し、その後に
  38 \(aq\e0\(aq を格納する。この関数はシフト状態 \fI*ps\fP を更新し(つまり初期状態に戻 し)、シフトシーケンスの長さに 1
  39 を加えた値を返す。この値は \fIs\fP に 書き込まれたバイト数である。
  40 .PP
  41 三番目のケースは、\fIs\fP が NULL の時である。 この場合には \fIwc\fP は無視され、関数の実際の動きとしては
  42
  43     wcrtomb(buf, L\(aq\e0\(aq, ps)
  44
  45 が返される。ここで、 \fIbuf\fP は内部的な無名バッファである。
  46 .PP
  47 以上のいずれの場合も、\fIps\fP が NULL ポインタならばシフト状態は用い られず、 \fBwcrtomb\fP()
  48 関数だけが知っている静的な匿名の状態が使われる。
  49 .SH 返り値
  50 \fBwcrtomb\fP()  関数は、\fIs\fP が指すバイト列に書き込まれたバイト数、あ るいは書き込まれたであろうバイト数を返す。\fIwc\fP
  51 を(現在のロケールに 従って)マルチバイト列で表現できなければ、 \fI(size_t)\ \-1\fP が返され、 \fIerrno\fP に \fBEILSEQ\fP
  52 が設定される。
  53 .SH 準拠
  54 C99.
  55 .SH 注意
  56 \fBwcrtomb\fP()  の動作は、現在のロケールの \fBLC_CTYPE\fP カテゴリに依存する。
  57 .PP
  58 \fIps\fP に NULL を渡した際の動作はマルチスレッドセーフでない。
  59 .SH 関連項目
  60 \fBwcsrtombs\fP(3)
  61 .SH この文書について
  62 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
  63 である。プロジェクトの説明とバグ報告に関する情報は
  64 http://www.kernel.org/doc/man\-pages/ に書かれている。