mbstowcs - ライブラリコールの説明 - Linux コマンド集一覧表

名前

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. マルチバイト文字列が終端の '\0' まで含めて完全に変換された場合。この場合は終端の L'\0' 文字を除いてdest に書き込まれた文字数を返す。

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

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

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

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

C99

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

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