release/man3/mbsrtowcs.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 MBSRTOWCS 3 2011\-09\-28 GNU "Linux Programmer's Manual"
  22 .SH 名前
  23 mbsrtowcs \- マルチバイト文字列をワイド文字列に変換する
  24 .SH 書式
  25 .nf
  26 \fB#include <wchar.h>\fP
  27 .sp
  28 \fBsize_t mbsrtowcs(wchar_t *\fP\fIdest\fP\fB, const char **\fP\fIsrc\fP\fB,\fP
  29 \fB                  size_t \fP\fIlen\fP\fB, mbstate_t *\fP\fIps\fP\fB);\fP
  30 .fi
  31 .SH 説明
  32 \fIdest\fP が NULL ポインターでなければ、 \fBmbsrtowcs\fP()  関数は マルチバイト文字列 \fI*src\fP を \fIdest\fP
  33 から始まるワイド文字列に 変換する。\fIdest\fP には最大で \fIlen\fP 文字のワイド文字が 書き込まれる。同時にシフト状態 \fI*ps\fP
  34 を更新する。 変換は \fImbrtowc(dest, *src, n, ps)\fP を、この呼び出しが成功する限り繰り返し実行したのと実質的に同様である。
  35 ここで \fIn\fP は正の数であり、繰り返しごとに \fIdest\fP が 1 増加させられ、 \fI*src\fP
  36 が消費したバイト数だけ増加させられる。変換は以下の三つの いずれかの条件で停止する:
  37 .IP 1. 3
  38 不正なマルチバイト列に遭遇した。この場合には \fI*src\fP は不正な マルチバイト列を指すようにして、 \fI(size_t)\ \-1\fP
  39 を返し、\fIerrno\fP に \fBEILSEQ\fP を設定する。
  40 .IP 2.
  41 \fIlen\fP 文字の L\(aq\e0\(aq 以外のワイド文字を \fIdest\fP に格納した場合。 この場合は \fI*src\fP
  42 は次に変換されるマルチバイト列を指すようにして、 \fIdest\fP に書き込まれたワイド文字の数を返す。
  43 .IP 3.
  44 マルチバイト文字列が終端の NULL ワイド文字 (\(aq\e0\(aq) まで含めて完全に 変換された場合。この時、副作用として \fI*ps\fP
  45 が初期状態に戻される。 この場合は \fI*src\fP には NULL が設定され、終端の NULL ワイド文字を除いて \fIdest\fP
  46 に書き込まれた文字数を返す。
  47 .PP
  48 \fIdest\fP が NULL の場合、\fIlen\fP は無視され、上記と同様の変換が 行われるが、変換されたワイド文字はメモリに書き込まれず、変換先の上限
  49 が存在しない。
  50 .PP
  51 上記のどちらの場合でも、\fIps\fP が NULL ポインターならば、 代りに \fBmbsrtowcs\fP()
  52 関数のみが使用する静的で名前のない状態が使用される。
  53 .PP
  54 プログラマーは \fIdest\fP に最低でも \fIlen\fP ワイド文字を書き込むこ とができる空間があることを保証しなければならない。
  55 .SH 返り値
  56 \fBmbsrtowcs\fP()  関数はワイド文字列に変換完了したワイド文字の数を返す。
  57 終端のナルワイド文字は含まない。不正なマルチバイト列に遭遇した場合には \fI(size_t)\ \-1\fP を返し、\fIerrno\fP に \fBEILSEQ\fP
  58 を設定する。
  59 .SH 準拠
  60 C99.
  61 .SH 注意
  62 \fBmbsrtowcs\fP()  の動作は現在のロケールの \fBLC_CTYPE\fP カテゴリに依存している。
  63 .PP
  64 \fIps\fP に NULL を渡した際の動作はマルチスレッドセーフでない。
  65 .SH 関連項目
  66 \fBiconv\fP(3), \fBmbsnrtowcs\fP(3), \fBmbstowcs\fP(3)
  67 .SH この文書について
  68 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
  69 である。プロジェクトの説明とバグ報告に関する情報は
  70 http://www.kernel.org/doc/man\-pages/ に書かれている。