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

   1 '\" te
   2 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   3 .\"  Copyright 1989 AT&T  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 2002, 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 MBLEN 3C "Jun 24, 2014"
  12 .SH NAME
  13 mblen, mblen_l \- get number of bytes in a character
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <stdlib.h>
  18
  19 \fBint\fR \fBmblen\fR(\fBconst char *\fR\fIs\fR, \fBsize_t\fR \fIn\fR);
  20 .fi
  21 .LP
  22 .nf
  23 #include <stdlib.h>
  24 #include <xlocale.h>
  25
  26 \fBint\fR \fBmblen_l\fR(\fBconst char *\fR\fIs\fR, \fBsize_t\fR \fIn\fR, \fBlocale_t\fR \fIloc\fR);
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 If \fIs\fR is not a null pointer, \fBmblen()\fR and \fBmblen_l()\fR
  33 determine the number of bytes constituting the character pointed to by
  34 \fIs\fR. The call
  35 .IP
  36 \fBmblen(\fIs\fR, \fIn\fR)\fR;
  37 .LP
  38 is equivalent to:
  39 .IP
  40 \fBmbtowc\fR((\fBwchar_t\fR *)0, \fIs\fR, \fIn\fR);
  41 .LP
  42 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
  43 .LP
  44 Whereas the behavior of the \fBmblen()\fR function is affected by the
  45 \fBLC_CTYPE\fR category of the current locale, the behavior of
  46 \fBmblen_l()\fR is affected by the \fBLC_CTYPE\fR category of the
  47 locale specified by \fIloc\fR.
  48 .SH RETURN VALUES
  49 .LP
  50 If \fIs\fR is a null pointer, \fBmblen()\fR and \fBmblen_l()\fR returns \fB0\fR. It \fIs\fR is not
  51 a null pointer, \fBmblen()\fR and \fBmblen_l()\fR returns \fB0\fR (if \fIs\fR points to the null
  52 byte), the number of bytes that constitute the character (if the next \fIn\fR
  53 or fewer bytes form a valid character), or  \fB\(mi1\fR (if they do not form a
  54 valid character) and may set \fBerrno\fR to indicate the error. In no case will
  55 the value returned be greater than \fIn\fR or the value of the \fBMB_CUR_MAX\fR
  56 macro.
  57 .SH ERRORS
  58 .sp
  59 .LP
  60 The \fBmblen()\fR and \fBmblen_l()\fR functions may fail if:
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBEILSEQ\fR\fR
  65 .ad
  66 .RS 10n
  67 Invalid character sequence is detected.
  68 .RE
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 CSI     Enabled
  83 _
  84 Interface Stability     See below.
  85 _
  86 MT-Level        MT-Safe
  87 .TE
  88
  89 .LP
  90 The
  91 .B mblen()
  92 function is Standard. The
  93 .B mblen_l()
  94 function is Uncommitted.
  95 .SH SEE ALSO
  96 .LP
  97 \fBmbstowcs\fR(3C), \fBmbtowc\fR(3C), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C),
  98 \fBwcstombs\fR(3C), \fBwctomb\fR(3C), \fBuselocale\fR(3C) \fBattributes\fR(5),
  99 \fBstandards\fR(5)