1 '\" te
   2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   3 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.  Portions Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH MBRLEN 3C "Jun 21, 2014"
  12 .SH NAME
  13 mbrlen, mbrlen_l \- get number of bytes in a character (restartable)
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <wchar.h>
  18 
  19 \fBsize_t\fR \fBmbrlen\fR(\fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR, \fBmbstate_t *restrict\fR \fIps\fR);
  20 .fi
  21 .LP
  22 .nf
  23 #include <wchar.h>
  24 #include <xlocale.h>
  25 
  26 \fBsize_t\fR \fBmbrlen_l\fR(\fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR, \fBmbstate_t *restrict\fR \fIps\fR,
  27     \fBlocale_t\fR \fIloc\fR);
  28 .fi
  29 .SH DESCRIPTION
  30 .LP
  31 If \fIs\fR is not a null pointer,  \fBmbrlen()\fR and \fBmbrlen_l()\fR determine
  32 the number of bytes constituting the character pointed to by \fIs\fR.
  33 The call
  34 .nf
  35 .IP
  36 \fBmbrlen\fR(\fIs\fR, \fIn\fR, \fIps\fR);
  37 .fi
  38 .LP
  39 is equivalent to:
  40 .nf
  41 .IP
  42 mbstate_t internal;
  43 \fBmbrtowc\fR(NULL, \fIs\fR, \fIn\fR, \fIps\fR != NULL ? \fIps\fR : &internal);
  44 .fi
  45 .LP
  46 If \fIps\fR is a null pointer, the \fBmbrlen()\fR and \fBmbrlen_l()\fR
  47 functions use their own
  48 internal \fBmbstate_t\fR object, which is initialized at program startup to the
  49 initial conversion state.   Otherwise, the  \fBmbstate_t\fR object pointed to
  50 by \fIps\fR is used to completely describe the current conversion state of the
  51 associated character sequence. The implemenation will behave as if no function
  52 defined in the Reference Manual calls \fBmbrlen()\fR.
  53 .LP
  54 The behavior of \fBmbrlen()\fR is affected by the \fBLC_CTYPE\fR category of the
  55 current locale.  See \fBenviron\fR(5). The behavior of \fBmbrlen_l()\fR does not
  56 use the current enivronment and instead uses the locale specified by \fBloc\fR.
  57 .SH RETURN VALUES
  58 .LP
  59 The \fBmbrlen()\fR and \fBmbrlen_l()\fR functions return the first of the
  60 following that applies:
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB0\fR\fR
  65 .ad
  66 .RS 17n
  67 If the next \fIn\fR or fewer bytes complete the character that corresponds to
  68 the null wide-character.
  69 .RE
  70 
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBpositive\fR\fR
  75 .ad
  76 .RS 17n
  77 If the next \fIn\fR or fewer bytes complete a valid character; the value
  78 returned is the number of bytes that complete the character.
  79 .RE
  80 
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB(size_t)\(mi2\fR\fR
  85 .ad
  86 .RS 17n
  87 If the next \fIn\fR bytes contribute to an incomplete but potentially valid
  88 character, and all \fIn\fR bytes have been processed. When \fIn\fR has at least
  89 the value of the \fBMB_CUR_MAX\fR macro, this case can only occur if  \fIs\fR
  90 points at a sequence of redundant shift sequences (for implementations with
  91 state-dependent encodings).
  92 .RE
  93 
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB(size_t)\(mi1\fR\fR
  98 .ad
  99 .RS 17n
 100 If an encoding error occurs, in which case the next \fIn\fR or fewer bytes do
 101 not contribute to a complete and valid  character.  In this case, \fBEILSEQ\fR
 102 is stored in \fBerrno\fR and the conversion state is undefined.
 103 .RE
 104 
 105 .SH ERRORS
 106 .LP
 107 The \fBmbrlen()\fR and \fBmbrlen_l()\fR functions may fail if:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBEINVAL\fR\fR
 112 .ad
 113 .RS 10n
 114 The \fIps\fR argument points to an object that contains an invalid conversion
 115 state.
 116 .RE
 117 
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBEILSEQ\fR\fR
 122 .ad
 123 .RS 10n
 124 Invalid character sequence is detected.
 125 .RE
 126 
 127 .SH ATTRIBUTES
 128 .LP
 129 See \fBattributes\fR(5) for descriptions of the following attributes:
 130 .TS
 131 box;
 132 c | c
 133 l | l .
 134 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 135 _
 136 Interface Stability     See below.
 137 _
 138 MT-Level        MT-Safe
 139 .TE
 140 
 141 .LP
 142 The
 143 .B mbrlen()
 144 function is Standard.  The
 145 .B mbrlen_l()
 146 function is Uncommitted.
 147 .SH SEE ALSO
 148 .LP
 149 \fBmbrtowc\fR(3C), \fBmbsinit\fR(3C), \fBnewlocale\fR(3C),
 150 \fBsetlocale\fR(3C), \fBattributes\fR(5),
 151 \fBenviron\fR(5), \fBstandards\fR(5)
 152 .SH NOTES
 153 .sp
 154 .LP
 155 If \fIps\fR is not a null pointer, \fBmbrlen()\fR uses the \fBmbstate_t\fR
 156 object pointed to by \fIps\fR and the function can be used safely in
 157 multithreaded applications, as long as \fBsetlocale\fR(3C) is not being called
 158 to change the locale or a per-thread locale has been installed on the calling
 159 thread with \fBuselocale\fR(3C). If \fIps\fR is a null pointer, \fBmbrlen()\fR
 160 uses its internal \fBmbstate_t\fR object and the function is Unsafe in
 161 multithreaded applications.