名前

mbrlen -次のマルチバイト文字の長さをバイト数で返す

書式

#include <wchar.h>
size_t mbrlen(const char * s , size_t n , mbstate_t * ps );

説明

mbrlen() 関数は s から始まるマルチバイト文字列を最大 n バイト調べて次の完全なマルチバイト文字を取り出す。同時にシフト状態 *ps を更新する。マルチバイト文字がナルワイド文字でなければ s から消費するバイト数を返す。ナルワイド文字ならばシフト状態 *ps を初期状態に戻して、0 を返す。

s から始まる n バイトの文字列が完全なマルチバイト文字を含んでいない場合には mbrlen() は (size_t) -2 を返す。マルチバイト文字列に冗長なシフトシーケンスを含まれていると n >= MB_CUR_MAX の時にもこのようなことが起こりえる。

s から始まるマルチバイト文字列が、次の完全な文字の前に不正なマルチバイト列を含んでいる場合には、 mbrlen() は (size_t) -1 を返し errno に EILSEQ が設定される。この場合の *ps への影響は未定義である。

ps が NULL ポインターならば、代りに mbrlen() 関数のみが使用する静的で名前のない状態が使用される。

返り値

ナルワイド文字以外の文字を確認した場合には、 mbrlen() 関数は s から始まるマルチバイト列から使用したバイト数を返す。ナルワイド文字が確認された場合にはゼロを返す。不正なマルチバイト列に遭遇した場合には (size_t) -1 を返し errno に EILSEQ を設定する。完全なマルチバイト文字を解析できなかった場合には (size_t) -2 を返す。これは n を増さなければならないことを意味する。

準拠

C99.

注意

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

関連項目

mbrtowc(3)

この文書について

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