original/man3/mblen.3

   1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\" %%%LICENSE_END
   9 .\"
  10 .\" References consulted:
  11 .\"   GNU glibc-2 source code and manual
  12 .\"   Dinkumware C library reference http://www.dinkumware.com/
  13 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
  14 .\"   ISO/IEC 9899:1999
  15 .\"
  16 .TH MBLEN 3  1999-07-25 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 mblen \- determine number of bytes in next multibyte character
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <stdlib.h>
  22 .sp
  23 .BI "int mblen(const char *" s ", size_t " n );
  24 .fi
  25 .SH DESCRIPTION
  26 If \fIs\fP is not a NULL pointer, the
  27 .BR mblen ()
  28 function inspects at most
  29 \fIn\fP bytes of the multibyte string starting at \fIs\fP and extracts the
  30 next complete multibyte character.
  31 It uses a static anonymous shift state only
  32 known to the
  33 .BR mblen ()
  34 function.
  35 If the multibyte character is not the null wide
  36 character, it returns the number of bytes that were consumed from \fIs\fP.
  37 If the multibyte character is the null wide character, it returns 0.
  38 .PP
  39 If the \fIn\fP bytes starting at \fIs\fP do not contain a complete multibyte
  40 character,
  41 .BR mblen ()
  42 returns \-1.
  43 This can happen even if
  44 \fIn\fP is greater than or equal to \fIMB_CUR_MAX\fP,
  45 if the multibyte string contains redundant shift sequences.
  46 .PP
  47 If the multibyte string starting at \fIs\fP contains an invalid multibyte
  48 sequence before the next complete character,
  49 .BR mblen ()
  50 also returns \-1.
  51 .PP
  52 If \fIs\fP is a NULL pointer, the
  53 .BR mblen ()
  54 function
  55 .\" The Dinkumware doc and the Single UNIX specification say this, but
  56 .\" glibc doesn't implement this.
  57 resets the shift state, only known to this function, to the initial state, and
  58 returns nonzero if the encoding has nontrivial shift state, or zero if the
  59 encoding is stateless.
  60 .SH RETURN VALUE
  61 The
  62 .BR mblen ()
  63 function returns the number of
  64 bytes parsed from the multibyte
  65 sequence starting at \fIs\fP, if a non-null wide character was recognized.
  66 It returns 0, if a null wide character was recognized.
  67 It returns \-1, if an
  68 invalid multibyte sequence was encountered or if it couldn't parse a complete
  69 multibyte character.
  70 .SH CONFORMING TO
  71 C99.
  72 .SH NOTES
  73 The behavior of
  74 .BR mblen ()
  75 depends on the
  76 .B LC_CTYPE
  77 category of the
  78 current locale.
  79 .PP
  80 The function
  81 .BR mbrlen (3)
  82 provides a better interface to the same
  83 functionality.
  84 .SH SEE ALSO
  85 .BR mbrlen (3)