1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH MBLEN 3C "Jul 24, 2002"
  11 .SH NAME
  12 mblen \- get number of bytes in a character
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdlib.h>
  17 
  18 \fBint\fR \fBmblen\fR(\fBconst char *\fR\fIs\fR, \fBsize_t\fR \fIn\fR);
  19 .fi
  20 
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 If \fIs\fR is not a null pointer, \fBmblen()\fR determines the number of bytes
  25 constituting the character pointed to by \fIs\fR. It is equivalent to:
  26 .sp
  27 .LP
  28 \fBmbtowc((wchar_t *)0, \fR\fIs\fR, \fIn\fR);
  29 .sp
  30 .LP
  31 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
  32 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
  33 current locale.
  34 .SH RETURN VALUES
  35 .sp
  36 .LP
  37 If \fIs\fR is a null pointer, \fBmblen()\fR returns \fB0\fR. It \fIs\fR is not
  38 a null pointer, \fBmblen()\fR returns \fB0\fR (if \fIs\fR points to the null
  39 byte), the number of bytes that constitute the character (if the next \fIn\fR
  40 or fewer bytes form a valid character), or  \fB\(mi1\fR (if they do not form a
  41 valid character) and may set \fBerrno\fR to indicate the error. In no case will
  42 the value returned be greater than \fIn\fR or the value of the \fBMB_CUR_MAX\fR
  43 macro.
  44 .SH ERRORS
  45 .sp
  46 .LP
  47 The \fBmblen()\fR function may fail if:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBEILSEQ\fR\fR
  52 .ad
  53 .RS 10n
  54 Invalid character sequence is detected.
  55 .RE
  56 
  57 .SH USAGE
  58 .sp
  59 .LP
  60 The \fBmblen()\fR function can be used safely in multithreaded applications, as
  61 long as \fBsetlocale\fR(3C) is not being called to change the locale.
  62 .SH ATTRIBUTES
  63 .sp
  64 .LP
  65 See \fBattributes\fR(5) for descriptions of the following attributes:
  66 .sp
  67 
  68 .sp
  69 .TS
  70 box;
  71 c | c
  72 l | l .
  73 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  74 _
  75 CSI     Enabled
  76 _
  77 Interface Stability     Standard
  78 _
  79 MT-Level        MT-Safe with exceptions
  80 .TE
  81 
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 \fBmbstowcs\fR(3C), \fBmbtowc\fR(3C), \fBsetlocale\fR(3C), \fBwcstombs\fR(3C),
  86 \fBwctomb\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)