usr/src/man/man3c/mbrlen.3c

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