release/man3/wctomb.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 .\" Japanese Version Copyright (c) 1999 HANATAKA Shinya
  15 .\"         all rights reserved.
  16 .\" Translated Tue Jan 11 00:55:39 JST 2000
  17 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  18 .\"
  19 .TH WCTOMB 3 1999-07-25 "GNU" "Linux Programmer's Manual"
  20 .SH 名前
  21 wctomb \- ワイド文字をマルチバイト列に変換する。
  22 .SH 書式
  23 .nf
  24 .B #include <stdlib.h>
  25 .sp
  26 .BI "int wctomb(char *" s ", wchar_t " wc );
  27 .fi
  28 .SH 説明
  29 .PP
  30 \fIs\fP が NULL でなければ、
  31 .BR wctomb ()
  32 関数はワイド文字 \fIwc\fP を
  33 マルチバイト表現に変換して \fIs\fP の指す文字配列に格納する。
  34 同時に wctomb 関数のみが使用する静的で名前のないシフト状態を更新する。
  35 この関数はマルチバイト表現の長さ、すなわち \fIs\fP に書き込まれた
  36 バイト数を返す。プログラマーは \fIs\fP に少なくとも \fBMB_CUR_MAX\fP
  37 バイトの空きがあることを保証しなければならない。
  38 .PP
  39 \fIs\fP が NULL ならば、
  40 .BR wctomb ()
  41 関数は自分のみが使用するシフト状態を
  42 初期状態に戻して、文字符号がシフト状態に依存しているならばゼロ以外を
  43 シフト状態に依存しない場合にはゼロを返す。
  44 .SH 返り値
  45 \fIs\fP が NULL でない場合
  46 .BR wctomb ()
  47 関数はバイト配列 \fIs\fP に
  48 書き込まれたバイト数を返す。\fIwc\fP が(現在のロケールにおいて)
  49 マルチバイト列で表現できない場合には \-1 を返す。
  50 .PP
  51 \fIs\fP が NULL の場合
  52 .BR wctomb ()
  53 関数は文字符号がシフト状態に
  54 依存している場合にはゼロ以外、シフト状態に依存しない場合はゼロを返す。
  55 .SH 準拠
  56 C99.
  57 .SH 注意
  58 .BR wctomb ()
  59 関数の動作は現在のロケールの
  60 .B LC_CTYPE
  61 カテゴリに依存している。
  62 .PP
  63 この関数はマルチスレッドでは安全ではない。
  64 .BR wcrtomb (3)
  65 関数は
  66 同じ機能のより良いインターフェースを提供する。
  67 .SH 関連項目
  68 .BR MB_CUR_MAX (3),
  69 .BR wcrtomb (3),
  70 .BR wcstombs (3)