1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Copyright (c) 2014, Joyent, 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 BTOWC 3C "Jul 24, 2002"
  12 .SH NAME
  13 btowc, btowc_l \- single-byte to wide-character conversion
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <stdio.h>
  18 #include <wchar.h>
  19 
  20 \fBwint_t\fR \fBbtowc\fR(\fBint\fR \fIc\fR);
  21 \fBwint_t\fR \fBbtowc_l\fR(\fBint\fR \fIc\fR, \fBlocale_t\fR \fIloc\fR);
  22 .fi
  23 
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBbtowc()\fR and \fBbtowc_l\fR()functions determines whether
  28 \fIc\fR constitutes a valid (one-byte) character in the initial shift
  29 state.
  30 .sp
  31 .LP
  32 The behavior of \fBbtowc\fR is affected by the \fBLC_CTYPE\fR category of the
  33 current locale.  See \fBenviron\fR(5). The function \fBbtowc_l\fR does
  34 not use the current locale, and instead operates on the locale \fIloc\fR
  35 provided to the function, obtained through a call to
  36 \fBnewlocale\fR(3C).
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 The \fBbtowc()\fR function returns \fBWEOF\fR if \fIc\fR has the value
  41 \fBEOF\fR or if  \fB(unsigned char)\fR\fIc\fR does not constitute a valid
  42 (one-byte) character in the initial shift state.  Otherwise, it returns the
  43 wide-character representation of that character.
  44 .SH ERRORS
  45 .sp
  46 .LP
  47 No errors are defined.
  48 .SH ATTRIBUTES
  49 .sp
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53 
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 Interface Stability     Standard
  62 _
  63 MT-Level        MT-Safe with exceptions
  64 .TE
  65 
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C), \fBwctob\fR(3C),
  70 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
  71 .SH NOTES
  72 .sp
  73 .LP
  74 The \fBbtowc()\fR function can be used safely in multithreaded applications, as
  75 long as \fBsetlocale\fR(3C) is not being called to change the locale.