MBSTOWCS(3)

名前
mbstowcs - マルチバイト文字列をワイド文字列に変換する

書式
#include <stdlib.h>

size_t mbstowcs(wchar_t *dest, const char *src, size_t n);

説明
dest が NULL ポインターでなければ mbstowcs() 関数は マルチバイト文字列 *src を dest から始まるワイド文字列に 変換する。dest には最大で n 文字のワイド文字が 書き込まれる。変換は初期状態で開始され、 以下の三つのいずれかの条件で停止する:

1.  不正なマルチバイト列に遭遇した。この場合には (size_t) -1 を返す。

2.  n 文字の L'\0' 以外のワイド文字を dest に格納した場合。 この場合は *src が次に変換されるマルチバイト列を指すようにして、 dest に書き込まれたワイド文字の数を返す。しかしこの指している 場所のシフト状態は失われる。

3.  マルチバイト文字列が終端の NULL ワイド文字 ('\0') まで含めて完全に 変換された場合。この場合は終端の NULL ワイド文字を除いて dest に書き込まれた文字数を返す。

プログラマーは dest に最低でも n ワイド文字を書き込むこ とができる空間があることを保証しなければならない。

dest が NULL の場合、n は無視され、上記と同様の変換が 行われるが、変換されたワイド文字はメモリに書き込まれず、変換先の上限 が存在しない。

上記の 2. の場合を避けるためにプログラマーは n が mbstowcs(NULL,src,0)+1 以上であることを保証すべきである。

返り値
mbstowcs() 関数はワイド文字列に変換完了したワイド文字の数を返す。 終端のナルワイド文字は含まない。不正なマルチバイト列に遭遇した場合には (size_t) -1 を返す。

準拠
C99.

注意
mbstowcs() の動作は現在のロケールの LC_CTYPE カテゴリに依存している。

mbsrtowcs(3) 関数は同じ機能のより良いインターフェースを提供する。

関連項目
mbsrtowcs(3), wcstombs(3)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.51 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。