Print this page
Garrett's man page edits.
   1 '\" te
   2 .\" 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 MBTOWC 3C "Nov 1, 2003"
  11 .SH NAME
  12 mbtowc, mbtowc_l \- convert a character to a wide-character code
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdlib.h>
  17 
  18 \fBint\fR \fBmbtowc\fR(\fBwchar_t *restrict\fR \fIpwc\fR, \fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR);
  19 \fBint\fR \fBmbtowc_l\fR(\fBwchar_t *restrict\fR \fIpwc\fR, \fBconst char *restrict\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, \fBmbtowc()\fR determines the number of the
  26 bytes that constitute the character pointed to by \fIs\fR. It then determines
  27 the wide-character code for the value of type \fBwchar_t\fR that corresponds to
  28 that character. (The value of the wide-character code corresponding to the null
  29 byte is 0.) If the character is valid and \fIpwc\fR is not a null pointer,
  30 \fBmbtowc()\fR stores the wide-character code in the object pointed to by
  31 \fIpwc\fR.
  32 .sp
  33 .LP
  34 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
  35 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
  36 current locale. At most \fIn\fR bytes of the array pointed to by \fIs\fR will
  37 be examined.
  38 .sp
  39 .LP
  40 The function \fBmbtowc_l()\fR behaves identically to \fBmbtowc()\fR, except
  41 instead of using the current locale, it uses the locale as specified by
  42 \fIloc\fR.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 If \fIs\fR is a null pointer, \fBmbtowc()\fR returns \fB0\fR. If \fIs\fR is not
  47 a null pointer, \fBmbtowc()\fR returns \fB0\fR (if \fIs\fR points to the null
  48 byte), the number of bytes that constitute the converted character (if the next
  49 \fIn\fR or fewer bytes form a valid character), or  \fB\(mi1\fR and may set
  50 \fBerrno\fR to indicate the error (if they do not form a valid character).
  51 .sp
  52 .LP
  53 In no case will the value returned be greater than \fIn\fR or the value of the
  54 \fBMB_CUR_MAX\fR macro.
  55 .SH ERRORS
  56 .sp
  57 .LP
  58 The \fBmbtowc()\fR function may fail if:
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBEILSEQ\fR\fR
  63 .ad
  64 .RS 10n
  65 Invalid character sequence is detected.
  66 .RE
  67 
  68 .SH USAGE
  69 .sp
  70 .LP
  71 The \fBmbtowc()\fR function can be used safely in multithreaded applications,
  72 as long as \fBsetlocale\fR(3C) is not being called to change the locale.
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78 
  79 .sp
  80 .TS
  81 box;
  82 l | l
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 CSI     Enabled
  87 _
  88 Interface Stability     Standard
  89 _
  90 MT-Level        MT-Safe with exceptions
  91 .TE
  92 






  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBmblen\fR(3C), \fBmbstowcs\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),

  97 \fBwcstombs\fR(3C), \fBwctomb\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
   1 '\" te
   2 .\" 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 MBTOWC 3C "Jun 23, 2014"
  11 .SH NAME
  12 mbtowc, mbtowc_l \- convert a character to a wide-character code
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdlib.h>
  17 
  18 \fBint\fR \fBmbtowc\fR(\fBwchar_t *restrict\fR \fIpwc\fR, \fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR);

  19 .fi
  20 .LP
  21 .nf
  22 #include <stdlib.h>
  23 #include <xlocale.h>
  24 
  25 \fBint\fR \fBmbtowc_l\fR(\fBwchar_t *restrict\fR \fIpwc\fR, \fBconst char *restrict\fR \fIs\fR, \fBsize_t\fR \fIn\fR,
  26     \fBlocale_t\fR \fIloc\fR);
  27 .fi
  28 .SH DESCRIPTION

  29 .LP
  30 If \fIs\fR is not a null pointer, \fBmbtowc()\fR determines the number of the
  31 bytes that constitute the character pointed to by \fIs\fR. It then determines
  32 the wide-character code for the value of type \fBwchar_t\fR that corresponds to
  33 that character. (The value of the wide-character code corresponding to the null
  34 byte is 0.) If the character is valid and \fIpwc\fR is not a null pointer,
  35 \fBmbtowc()\fR stores the wide-character code in the object pointed to by
  36 \fIpwc\fR.

  37 .LP
  38 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
  39 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
  40 current locale. At most \fIn\fR bytes of the array pointed to by \fIs\fR will
  41 be examined.

  42 .LP
  43 The function \fBmbtowc_l()\fR behaves identically to \fBmbtowc()\fR, except
  44 instead of using the current locale, it uses the locale as specified by
  45 \fIloc\fR.
  46 .SH RETURN VALUES

  47 .LP
  48 If \fIs\fR is a null pointer, these functions return \fB0\fR. If \fIs\fR is not
  49 a null pointer, they return \fB0\fR (if \fIs\fR points to the null
  50 byte), the number of bytes that constitute the converted character (if the next
  51 \fIn\fR or fewer bytes form a valid character), or  \fB\(mi1\fR and may set
  52 \fBerrno\fR to indicate the error (if they do not form a valid character).

  53 .LP
  54 In no case will the value returned be greater than \fIn\fR or the value of the
  55 \fBMB_CUR_MAX\fR macro.
  56 .SH ERRORS

  57 .LP
  58 The \fBmbtowc()\fR and \fBmbtowc_l()\fR functions may fail if:
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBEILSEQ\fR\fR
  63 .ad
  64 .RS 10n
  65 Invalid character sequence is detected.
  66 .RE






  67 .SH ATTRIBUTES

  68 .LP
  69 See \fBattributes\fR(5) for descriptions of the following attributes:



  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 CSI     Enabled
  77 _
  78 Interface Stability     See below.
  79 _
  80 MT-Level        MT-Safe
  81 .TE
  82 
  83 .LP
  84 The
  85 .B mbtowc()
  86 function is Standard.  The
  87 .B mbtowc_l()
  88 function is Uncommitted.
  89 .SH SEE ALSO

  90 .LP
  91 \fBmblen\fR(3C), \fBmbstowcs\fR(3C),
  92 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
  93 \fBwcstombs\fR(3C), \fBwctomb\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)