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

名前

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

#include <stdlib.h>


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

dest が NULL ポインタでない場合、wcstombs () 関数はワイド文字列 src を dest から始まるマルチバイト文字列に変換する。dest には最大で n バイトが書き込まれる。変換は初期状態で開始される。変換は以下の3つの理由により停止する。

1. (現在のロケールにおける)マルチバイト列で表現できないワイド文字に遭遇した場合。この場合には (size_t)(-1) が返される。

2. 長さ制限によって強制停止させられた場合。この場合には dest に書き込まれたバイト数が返される。しかしこの時点でのシフト状態は失われる。

3. ワイド文字列が終端の L'\0' を含めて完全に変換された場合。この場合には変換は初期状態で終り、終端の '\0' バイトを除いて dest に書き込まれたバイト数を返す。

プログラマーは dest に最低でも n バイトの空きがあることを保証しなければならない。

dest が NULL の場合、n は無視される。上記と同様に変換が行なわれるが変換結果のバイト列はメモリには書き込まれない。また長さの上限が存在しない。

上記の 2. の場合を避けるために、プログラマーは n が wcstombs(NULL,src,0)+1 以上であることを保証しなければならない。

wcstombs () 関数は生成したマルチバイト列のバイト数を返す。終端のナル文字は含まない。もし変換できないワイド文字に遭遇した場合には (size_t)(-1) を返す。

C99.

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

wcsrtombs () 関数は同じ機能のためのスレッド・セーフなインターフェースを提供する。