名前

       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 を増さなければならないことを
       意味する。

属性

       この節で使用されている用語の説明については、 attributes(7) を参照。

       ┌─────────────────┬───────────────┬───────────────────────────┐
       │インターフェース │ 属性          │ 値                        │
       ├─────────────────┼───────────────┼───────────────────────────┤
       │mbrlen()         │ Thread safety │ MT-Unsafe race:mbrlen/!ps │
       └─────────────────┴───────────────┴───────────────────────────┘

準拠

       POSIX.1-2001, POSIX.1-2008, C99.

注意

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

関連項目

       mbrtowc(3)

この文書について

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