release/man3/mbstowcs.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 MBSTOWCS 3 2011\-09\-28 GNU "Linux Programmer's Manual"
  20 .SH 名前
  21 mbstowcs \- マルチバイト文字列をワイド文字列に変換する
  22 .SH 書式
  23 .nf
  24 \fB#include <stdlib.h>\fP
  25 .sp
  26 \fBsize_t mbstowcs(wchar_t *\fP\fIdest\fP\fB, const char *\fP\fIsrc\fP\fB, size_t \fP\fIn\fP\fB);\fP
  27 .fi
  28 .SH 説明
  29 \fIdest\fP が NULL ポインターでなければ \fBmbstowcs\fP()  関数は マルチバイト文字列 \fI*src\fP を \fIdest\fP
  30 から始まるワイド文字列に 変換する。\fIdest\fP には最大で \fIn\fP 文字のワイド文字が 書き込まれる。変換は初期状態で開始され、
  31 以下の三つのいずれかの条件で停止する:
  32 .IP 1. 3
  33 不正なマルチバイト列に遭遇した。この場合には \fI(size_t)\ \-1\fP を返す。
  34 .IP 2.
  35 \fIn\fP 文字の L\(aq\e0\(aq 以外のワイド文字を \fIdest\fP に格納した場合。 この場合は \fI*src\fP
  36 が次に変換されるマルチバイト列を指すようにして、 \fIdest\fP に書き込まれたワイド文字の数を返す。しかしこの指している 場所のシフト状態は失われる。
  37 .IP 3.
  38 マルチバイト文字列が終端の NULL ワイド文字 (\(aq\e0\(aq) まで含めて完全に 変換された場合。この場合は終端の NULL
  39 ワイド文字を除いて \fIdest\fP に書き込まれた文字数を返す。
  40 .PP
  41 プログラマーは \fIdest\fP に最低でも \fIn\fP ワイド文字を書き込むこ とができる空間があることを保証しなければならない。
  42 .PP
  43 \fIdest\fP が NULL の場合、\fIn\fP は無視され、上記と同様の変換が 行われるが、変換されたワイド文字はメモリに書き込まれず、変換先の上限
  44 が存在しない。
  45 .PP
  46 上記の 2. の場合を避けるためにプログラマーは \fIn\fP が \fImbstowcs(NULL,src,0)+1\fP 以上であることを保証すべきである。
  47 .SH 返り値
  48 \fBmbstowcs\fP()  関数はワイド文字列に変換完了したワイド文字の数を返す。
  49 終端のナルワイド文字は含まない。不正なマルチバイト列に遭遇した場合には \fI(size_t)\ \-1\fP を返す。
  50 .SH 準拠
  51 C99.
  52 .SH 注意
  53 \fBmbstowcs\fP()  の動作は現在のロケールの \fBLC_CTYPE\fP カテゴリに依存している。
  54 .PP
  55 \fBmbsrtowcs\fP(3)  関数は同じ機能のより良いインターフェースを提供する。
  56 .SH 関連項目
  57 \fBmbsrtowcs\fP(3), \fBwcstombs(3)\fP