release/man3/mbsnrtowcs.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 .\"
  15 .\"*******************************************************************
  16 .\"
  17 .\" This file was generated with po4a. Translate the source file.
  18 .\"
  19 .\"*******************************************************************
  20 .\"
  21 .\" Japanese Version Copyright (c) 1999 HANATAKA Shinya
  22 .\"         all rights reserved.
  23 .\" Translated Tue Jan 11 00:56:10 JST 2000
  24 .\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
  25 .\"
  26 .TH MBSNRTOWCS 3 2014\-03\-18 GNU "Linux Programmer's Manual"
  27 .SH 名前
  28 mbsnrtowcs \- マルチバイト文字列をワイド文字列に変換する
  29 .SH 書式
  30 .nf
  31 \fB#include <wchar.h>\fP
  32 .sp
  33 \fBsize_t mbsnrtowcs(wchar_t *\fP\fIdest\fP\fB, const char **\fP\fIsrc\fP\fB,\fP
  34 \fB                  size_t \fP\fInms\fP\fB, size_t \fP\fIlen\fP\fB, mbstate_t *\fP\fIps\fP\fB);\fP
  35 .fi
  36 .sp
  37 .in -4n
  38 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  39 .in
  40 .sp
  41 \fBmbsnrtowcs\fP():
  42 .PD 0
  43 .ad l
  44 .RS 4
  45 .TP  4
  46 glibc 2.10 以降:
  47 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  48 .TP
  49 glibc 2.10 より前:
  50 _GNU_SOURCE
  51 .RE
  52 .ad
  53 .PD
  54 .SH 説明
  55 \fBmbsnrtowcs\fP()  関数は \fBmbsrtowcs\fP(3)  関数に似ているが 変換するバイト数が \fI*src\fP から始まる
  56 \fInms\fP バイトに制限されている 点が異なっている。
  57 .PP
  58 \fIdest\fP が NULL でなければ \fBmbsnrtowcs\fP()  関数は \fI*src\fP からのマルチバイト文字列の最大 \fInms\fP までを
  59 \fIdest\fP からのワイド文字列に変換する。 最大 \fIlen\fP 文字のワイド文字が \fIdest\fP に書き込まれる。 同時にシフト状態 \fI*ps\fP
  60 を更新する。 変換は \fImbrtowc(dest, *src, n, ps)\fP
  61 を、この呼び出しが成功する限り、繰り返し実行したのと実質的に同様である。 ここでの \fIn\fP は正の数であり、繰り返しごとに \fIdest\fP が 1
  62 増加させられ、 \fI*src\fP が消費したバイト数だけ増加させられる。変換は以下の三つの いずれかの条件で停止する:
  63 .IP 1. 3
  64 不正なマルチバイト列に遭遇した。この場合には \fI*src\fP は不正な マルチバイト列を指すようにして、 \fI(size_t)\ \-1\fP
  65 を返し、\fIerrno\fP に \fBEILSEQ\fP を設定する。
  66 .IP 2.
  67 \fInms\fP 制限によって強制的に停止するか、\fIlen\fP 文字の L\(aq\e0\(aq 以外の ワイド文字を \fIdest\fP
  68 に格納した場合。この場合は \fI*src\fP は 次に変換されるマルチバイト列を指すようにして、\fIdest\fP に書き込まれた ワイド文字の数を返す。
  69 .IP 3.
  70 マルチバイト文字列が終端のヌルワイド文字 (\(aq\e0\(aq)  まで含めて完全に変換された場合。 (この時、副作用として \fI*ps\fP
  71 が初期状態に戻される。)  この場合は \fI*src\fP には NULL が設定され、 \fIdest\fP に書き込まれた文字数 (終端の
  72 ヌルワイド文字は含まれない) を返す。
  73 .PP
  74 \fIdest\fP が NULL の場合、\fIlen\fP は無視され、上記と同様の変換が 行われるが、変換されたワイド文字はメモリに書き込まれず、変換先の上限
  75 が存在しない。
  76 .PP
  77 上記のどちらの場合でも、\fIps\fP が NULL ならば、 代りに \fBmbsnrtowcs\fP() 関数のみが使用する静的で名前のない状態が使用される。
  78 .PP
  79 プログラマーは \fIdest\fP に最低でも \fIlen\fP ワイド文字を書き込むこ とができる空間があることを保証しなければならない。
  80 .SH 返り値
  81 \fBmbsnrtowcs\fP()  関数はワイド文字列に変換完了したワイド文字の数を返す。
  82 終端のナルワイド文字は含まない。不正なマルチバイト列に遭遇した場合には \fI(size_t)\ \-1\fP を返し、\fIerrno\fP に \fBEILSEQ\fP
  83 を設定する。
  84 .SH 準拠
  85 POSIX.1\-2008.
  86 .SH 注意
  87 \fBmbsnrtowcs\fP()  の動作は現在のロケールの \fBLC_CTYPE\fP カテゴリに依存している。
  88 .PP
  89 \fIps\fP に NULL を渡した際の動作はマルチスレッドセーフでない。
  90 .SH 関連項目
  91 \fBiconv\fP(3), \fBmbrtowc\fP(3)  \fBmbsinit\fP(3), \fBmbsrtowcs\fP(3)
  92 .SH この文書について
  93 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.67 の一部
  94 である。プロジェクトの説明とバグ報告に関する情報は
  95 http://www.kernel.org/doc/man\-pages/ に書かれている。