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 .\"*******************************************************************
  15 .\"
  16 .\" This file was generated with po4a. Translate the source file.
  17 .\"
  18 .\"*******************************************************************
  19 .TH WCSTOMBS 3 2011\-10\-16 GNU "Linux Programmer's Manual"
  20 .SH 名前
  21 wcstombs \- ワイド文字列をマルチバイト文字列に変換する
  22 .SH 書式
  23 .nf
  24 \fB#include <stdlib.h>\fP
  25 .sp
  26 \fBsize_t wcstombs(char *\fP\fIdest\fP\fB, const wchar_t *\fP\fIsrc\fP\fB, size_t \fP\fIn\fP\fB);\fP
  27 .fi
  28 .SH 説明
  29 \fIdest\fP が NULL ポインタでない場合、 \fBwcstombs\fP()  関数は ワイド文字列 \fIsrc\fP を \fIdest\fP
  30 から始まるマルチバイト文字列に 変換する。\fIdest\fP には最大で \fIn\fP バイトが書き込まれる。
  31 変換は初期状態で開始される。変換は以下の3つの理由により停止する。
  32 .PP
  33 1. (現在のロケールにおける)マルチバイト列で表現できないワイド文字に 遭遇した場合。この場合には \fI(size_t)\ \-1\fP が返される。
  34 .PP
  35 2. 長さ制限によって強制停止させられた場合。この場合には \fIdest\fP に 書き込まれたバイト数が返される。しかしこの時点でのシフト状態は失われる。
  36 .PP
  37 3. ワイド文字列が終端の NULL ワイド文字 (L\(aq\e0\(aq) を含めて完全に変換された場合。
  38 この場合には変換は初期状態で終了し、 \fIdest\fP に書き込まれたバイト数を返す
  39 (終端の NULL バイト (\(aq\e0\(aq) は含まれない)。
  40 .PP
  41 プログラマーは \fIdest\fP に最低でも \fIn\fP バイトの空きがあることを 保証しなければならない。
  42 .PP
  43 \fIdest\fP が NULL の場合、\fIn\fP は無視される。上記と同様に変換が行 なわれるが変換結果のバイト列はメモリには書き込まれない。
  44 また長さの上限が存在しない。
  45 .PP
  46 上記の 2. の場合を避けるために、プログラマーは \fIn\fP が \fIwcstombs(NULL,src,0)+1\fP
  47 以上であることを保証しなければならない。
  48 .SH 返り値
  49 \fBwcstombs\fP()  関数は生成したマルチバイト列のバイト数を返す。終端の ナル文字は含まない。もし変換できないワイド文字に遭遇した場合には
  50 \fI(size_t)\ \-1\fP を返す。
  51 .SH 準拠
  52 C99.
  53 .SH 注意
  54 \fBwcstombs\fP()  の動作は現在のロケールの \fBLC_CTYPE\fP カテゴリに依存している。
  55 .PP
  56 \fBwcsrtombs\fP()  関数は同じ機能のためのスレッド・セーフな インターフェースを提供する。
  57 .SH 関連項目
  58 \fBmbstowcs\fP(3), \fBwcsrtombs\fP(3)