manual/LDP_man-pages/release/man3/wcstombs.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:41 JST 2000
  17 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  18 .\"
  19 .TH WCSTOMBS 3  2011-09-28 "GNU" "Linux Programmer's Manual"
  20 .SH 名前
  21 wcstombs \- ワイド文字列をマルチバイト文字列に変換する
  22 .SH 書式
  23 .nf
  24 .B #include <stdlib.h>
  25 .sp
  26 .BI "size_t wcstombs(char *" dest ", const wchar_t *" src ", size_t " n );
  27 .fi
  28 .SH 説明
  29 \fIdest\fP が NULL ポインタでない場合、
  30 .BR wcstombs ()
  31 関数は
  32 ワイド文字列 \fIsrc\fP を \fIdest\fP から始まるマルチバイト文字列に
  33 変換する。\fIdest\fP には最大で \fIn\fP バイトが書き込まれる。
  34 変換は初期状態で開始される。変換は以下の3つの理由により停止する。
  35 .PP
  36 1. (現在のロケールにおける)マルチバイト列で表現できないワイド文字に
  37 遭遇した場合。この場合には
  38 .I (size_t)\ \-1
  39 が返される。
  40 .PP
  41 2. 長さ制限によって強制停止させられた場合。この場合には \fIdest\fP に
  42 書き込まれたバイト数が返される。しかしこの時点でのシフト状態は失われる。
  43 .PP
  44 3. ワイド文字列が終端の NULL ワイド文字 (L\(aq\\0\(aq) を含めて
  45 完全に変換された場合。この場合には変換は初期状態で終り、
  46 \fIdest\fP に書き込まれたバイト数 (終端の NULL は含まれない) を返す。
  47 .PP
  48 プログラマーは \fIdest\fP に最低でも \fIn\fP バイトの空きがあることを
  49 保証しなければならない。
  50 .PP
  51 \fIdest\fP が NULL の場合、\fIn\fP は無視される。上記と同様に変換が行
  52 なわれるが変換結果のバイト列はメモリには書き込まれない。
  53 また長さの上限が存在しない。
  54 .PP
  55 上記の 2. の場合を避けるために、プログラマーは \fIn\fP が
  56 \fIwcstombs(NULL,src,0)+1\fP 以上であることを保証しなければならない。
  57 .SH 返り値
  58 .BR wcstombs ()
  59 関数は生成したマルチバイト列のバイト数を返す。終端の
  60 ナル文字は含まない。もし変換できないワイド文字に遭遇した場合には
  61 .I (size_t)\ \-1
  62 を返す。
  63 .SH 準拠
  64 C99.
  65 .SH 注意
  66 .BR wcstombs ()
  67 の動作は現在のロケールの
  68 .B LC_CTYPE
  69 カテゴリに依存している。
  70 .PP
  71 .BR wcsrtombs ()
  72 関数は同じ機能のためのスレッド・セーフな
  73 インターフェースを提供する。
  74 .SH 関連項目
  75 .BR mbstowcs (3),
  76 .BR wcsrtombs (3)