release/man3/mbrlen.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" References consulted:
   9 .\"   GNU glibc-2 source code and manual
  10 .\"   Dinkumware C library reference http://www.dinkumware.com/
  11 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  12 .\"   ISO/IEC 9899:1999
  13 .\"
  14 .\"*******************************************************************
  15 .\"
  16 .\" This file was generated with po4a. Translate the source file.
  17 .\"
  18 .\"*******************************************************************
  19 .TH MBRLEN 3 1999\-07\-25 GNU "Linux Programmer's Manual"
  20 .SH 名前
  21 mbrlen \- 次のマルチバイト文字の長さをバイト数で返す
  22 .SH 書式
  23 .nf
  24 \fB#include <wchar.h>\fP
  25 .sp
  26 \fBsize_t mbrlen(const char *\fP\fIs\fP\fB, size_t \fP\fIn\fP\fB, mbstate_t *\fP\fIps\fP\fB);\fP
  27 .fi
  28 .SH 説明
  29 \fBmbrlen\fP()  関数は \fIs\fP から始まるマルチバイト文字列を 最大 \fIn\fP バイト調べて次の完全なマルチバイト文字を取り出す。
  30 同時にシフト状態 \fI*ps\fP を更新する。 マルチバイト文字がナルワイド文字でなければ \fIs\fP から
  31 消費するバイト数を返す。ナルワイド文字ならばシフト状態 \fI*ps\fP を 初期状態に戻して、0 を返す。
  32 .PP
  33 \fIs\fP から始まる \fIn\fP バイトの文字列が完全なマルチバイト文字を含んで いない場合には \fBmbrlen\fP()  は \fI(size_t)\ \-2\fP を返す。 マルチバイト文字列に冗長なシフトシーケンスを含まれていると \fIn\fP >= \fIMB_CUR_MAX\fP
  34 の時にもこのようなことが起こりえる。
  35 .PP
  36 \fIs\fP から始まるマルチバイト文字列が、次の完全な文字の前に 不正なマルチバイト列を含んでいる場合には、 \fBmbrlen\fP()  は
  37 \fI(size_t)\ \-1\fP を返し \fIerrno\fP に \fBEILSEQ\fP が設定される。 この場合の \fI*ps\fP への影響は未定義である。
  38 .PP
  39 \fIps\fP が NULL ポインターならば、代りに \fBmbrlen\fP()  関数のみが使用する静的で名前のない状態が使用される。
  40 .SH 返り値
  41 ナルワイド文字以外の文字を確認した場合には、 \fBmbrlen\fP()  関数は \fIs\fP から始まるマルチバイト列から使用したバイト数を返す。
  42 ナルワイド文字が確認された場合にはゼロを返す。 不正なマルチバイト列に遭遇した場合には \fI(size_t)\ \-1\fP を返し \fIerrno\fP に
  43 \fBEILSEQ\fP を設定する。 完全なマルチバイト文字を解析できなかった場合には \fI(size_t)\ \-2\fP を返す。 これは \fIn\fP
  44 を増さなければならないことを意味する。
  45 .SH 準拠
  46 C99.
  47 .SH 注意
  48 \fBmbrlen\fP()  の動作は現在のロケールの \fBLC_CTYPE\fP カテゴリに依存している。
  49 .SH 関連項目
  50 \fBmbrtowc\fP(3)