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, mblen_l \- 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 \fBint\fR \fBmblen_l\fR(\fBconst char *\fR\fIs\fR, \fBsize_t\fR \fIn\fR, \fBlocale_t\fR \fIloc\fR); 20 .fi 21 22 .SH DESCRIPTION 23 .sp 24 .LP 25 If \fIs\fR is not a null pointer, \fBmblen()\fR and \fBmblen_l()\fR 26 determines the number of bytes constituting the character pointed to by 27 \fIs\fR. It is equivalent to: 28 .sp 29 .LP 30 \fBmbtowc((wchar_t *)0, \fR\fIs\fR, \fIn\fR); 31 .sp 32 .LP 33 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR. 34 The behavior of the \fBmblen()\fR function is affected by the \fBLC_CTYPE\fR 35 category of the current locale. The \fBmblen_l()\fR function is affected as 36 well, but rather than using the current locale, it uses the locale specified by 37 \fIlocl\fR. 38 39 .SH RETURN VALUES 40 .sp 41 .LP 42 If \fIs\fR is a null pointer, \fBmblen()\fR and \fBmblen_l()\fR returns \fB0\fR. It \fIs\fR is not 43 a null pointer, \fBmblen()\fR and \fBmblen_l()\fR returns \fB0\fR (if \fIs\fR points to the null 44 byte), the number of bytes that constitute the character (if the next \fIn\fR 45 or fewer bytes form a valid character), or \fB\(mi1\fR (if they do not form a 46 valid character) and may set \fBerrno\fR to indicate the error. In no case will 47 the value returned be greater than \fIn\fR or the value of the \fBMB_CUR_MAX\fR 48 macro. 49 .SH ERRORS 50 .sp 51 .LP 52 The \fBmblen()\fR and \fBmblen_l()\fR functions may fail if: 53 .sp 54 .ne 2 55 .na 56 \fB\fBEILSEQ\fR\fR 57 .ad 58 .RS 10n 59 Invalid character sequence is detected. 60 .RE 61 62 .SH USAGE 63 .sp 64 .LP 65 The \fBmblen()\fR function can be used safely in multithreaded applications, as 66 long as \fBsetlocale\fR(3C) is not being called to change the locale or if a 67 per-thread locale has been set for the calling thread with the 68 \fBuselocale\fR(3C) function. The \fBmblen_l()\fR function is similarly safe, as 69 long as the \fBfreelocale\fR(3C) function is not called on the locale passed 70 into the function. 71 .SH ATTRIBUTES 72 .sp 73 .LP 74 See \fBattributes\fR(5) for descriptions of the following attributes: 75 .sp 76 77 .sp 78 .TS 79 box; 80 c | c 81 l | l . 82 ATTRIBUTE TYPE ATTRIBUTE VALUE 83 _ 84 CSI Enabled 85 _ 86 Interface Stability Standard 87 _ 88 MT-Level MT-Safe with exceptions 89 .TE 90 91 .SH SEE ALSO 92 .sp 93 .LP 94 \fBfreelocale\fR(3C), \fBmbstowcs\fR(3C), \fBmbtowc\fR(3C), \fBsetlocale\fR(3C), 95 \fBwcstombs\fR(3C), \fBwctomb\fR(3C), \fBuselocale\fR(3C) \fBattributes\fR(5), 96 \fBstandards\fR(5)