Print this page
2964 need POSIX 2008 locale object support
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Gordon Ross <gordon.ross@nexenta.com>
Approved by: TBD

Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3c/mblen.3c
          +++ new/usr/src/man/man3c/mblen.3c
   1    1  '\" te
        2 +.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   2    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
   3    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
   4    5  .\" http://www.opengroup.org/bookstore/.
   5    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.
   6    7  .\"  This notice shall appear on any product containing this material.
   7    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.
   8    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.
   9   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]
  10      -.TH MBLEN 3C "Jul 24, 2002"
       11 +.TH MBLEN 3C "Jun 24, 2014"
  11   12  .SH NAME
  12      -mblen \- get number of bytes in a character
       13 +mblen, mblen_l \- get number of bytes in a character
  13   14  .SH SYNOPSIS
  14   15  .LP
  15   16  .nf
  16   17  #include <stdlib.h>
  17   18  
  18   19  \fBint\fR \fBmblen\fR(\fBconst char *\fR\fIs\fR, \fBsize_t\fR \fIn\fR);
  19   20  .fi
       21 +.LP
       22 +.nf
       23 +#include <stdlib.h>
       24 +#include <xlocale.h>
  20   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 +
  21   29  .SH DESCRIPTION
  22   30  .sp
  23   31  .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
       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;
  27   37  .LP
  28      -\fBmbtowc((wchar_t *)0, \fR\fIs\fR, \fIn\fR);
  29      -.sp
       38 +is equivalent to:
       39 +.IP
       40 +\fBmbtowc\fR((\fBwchar_t\fR *)0, \fIs\fR, \fIn\fR);
  30   41  .LP
  31   42  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.
       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.
  34   48  .SH RETURN VALUES
  35      -.sp
  36   49  .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
       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
  39   52  byte), the number of bytes that constitute the character (if the next \fIn\fR
  40   53  or fewer bytes form a valid character), or  \fB\(mi1\fR (if they do not form a
  41   54  valid character) and may set \fBerrno\fR to indicate the error. In no case will
  42   55  the value returned be greater than \fIn\fR or the value of the \fBMB_CUR_MAX\fR
  43   56  macro.
  44   57  .SH ERRORS
  45   58  .sp
  46   59  .LP
  47      -The \fBmblen()\fR function may fail if:
       60 +The \fBmblen()\fR and \fBmblen_l()\fR functions may fail if:
  48   61  .sp
  49   62  .ne 2
  50   63  .na
  51   64  \fB\fBEILSEQ\fR\fR
  52   65  .ad
  53   66  .RS 10n
  54   67  Invalid character sequence is detected.
  55   68  .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   69  .SH ATTRIBUTES
  63   70  .sp
  64   71  .LP
  65   72  See \fBattributes\fR(5) for descriptions of the following attributes:
  66   73  .sp
  67   74  
  68   75  .sp
  69   76  .TS
  70   77  box;
  71   78  c | c
  72   79  l | l .
  73   80  ATTRIBUTE TYPE  ATTRIBUTE VALUE
  74   81  _
  75   82  CSI     Enabled
  76   83  _
  77      -Interface Stability     Standard
       84 +Interface Stability     See below.
  78   85  _
  79      -MT-Level        MT-Safe with exceptions
       86 +MT-Level        MT-Safe
  80   87  .TE
  81   88  
       89 +.LP
       90 +The
       91 +.B mblen()
       92 +function is Standard. The
       93 +.B mblen_l()
       94 +function is Uncommitted.
  82   95  .SH SEE ALSO
  83      -.sp
  84   96  .LP
  85      -\fBmbstowcs\fR(3C), \fBmbtowc\fR(3C), \fBsetlocale\fR(3C), \fBwcstombs\fR(3C),
  86      -\fBwctomb\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
       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)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX