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 "Jun 27, 2014"
  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 .fi
  22 .LP
  23 .nf
  24 #include <stdio.h>
  25 #include <wchar.h>
  26 #include <xlocale.h>
  27 
  28 \fBwint_t\fR \fBbtowc_l\fR(\fBint\fR \fIc\fR, \fBlocale_t\fR \fIloc\fR);
  29 .fi
  30 .SH DESCRIPTION
  31 .LP
  32 The \fBbtowc()\fR and \fBbtowc_l\fR()functions determines whether
  33 \fIc\fR constitutes a valid (one-byte) character in the initial shift
  34 state.
  35 .LP
  36 The behavior of \fBbtowc()\fR is affected by the \fBLC_CTYPE\fR category of the
  37 current locale.  See \fBenviron\fR(5). The function \fBbtowc_l()\fR does
  38 not use the current locale, and instead operates on the locale
  39 specified by \fIloc\fR.
  40 .SH RETURN VALUES
  41 .LP
  42 The \fBbtowc()\fR function returns \fBWEOF\fR if \fIc\fR has the value
  43 \fBEOF\fR or if  \fB(unsigned char)\fR\fIc\fR does not constitute a valid
  44 (one-byte) character in the initial shift state.  Otherwise, it returns the
  45 wide-character representation of that character.
  46 .SH ERRORS
  47 .LP
  48 No errors are defined.
  49 .SH ATTRIBUTES
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .TS
  53 box;
  54 c | c
  55 l | l .
  56 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  57 _
  58 Interface Stability     See below.
  59 _
  60 MT-Level        MT-Safe
  61 .TE
  62 
  63 .LP
  64 The
  65 .B btowc()
  66 function is Standard.  The
  67 .B btowc_l()
  68 function is Uncommitted.
  69 .SH SEE ALSO
  70 .sp
  71 .LP
  72 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C), \fBwctob\fR(3C),
  73 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)