1.\" $OpenBSD: btowc.3,v 1.3 2013/06/05 03:39:22 tedu Exp $ 2.\" $NetBSD: btowc.3,v 1.3 2003/04/16 13:34:40 wiz Exp $ 3.\" 4.\" Copyright (c)2003 Citrus Project, 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.Dd $Mdocdate: June 5 2013 $ 29.Dt BTOWC 3 30.Os 31.\" ---------------------------------------------------------------------- 32.Sh NAME 33.Nm btowc 34.Nd convert a single byte character to a wide character 35.\" ---------------------------------------------------------------------- 36.Sh SYNOPSIS 37.In wchar.h 38.Ft wint_t 39.Fn btowc "int c" 40.\" ---------------------------------------------------------------------- 41.Sh DESCRIPTION 42The 43.Fn btowc 44function converts a single byte character 45.Fa c 46in the initial shift state of the current locale to a corresponding 47wide character. 48.Pp 49The behaviour of the 50.Fn btowc 51is affected by the 52.Dv LC_CTYPE 53category of the current locale. 54.\" ---------------------------------------------------------------------- 55.Sh RETURN VALUES 56The 57.Fn btowc 58function returns: 59.Bl -tag -width 012345678901 60.It Dv WEOF 61If 62.Fa c 63is 64.Dv EOF 65or if (unsigned char) 66.Fa c 67does not correspond to a valid single byte character representation. 68.It (otherwise) 69A wide character corresponding to 70.Fa c . 71.El 72.\" ---------------------------------------------------------------------- 73.Sh ERRORS 74No errors are defined. 75.\" ---------------------------------------------------------------------- 76.Sh SEE ALSO 77.Xr mbrtowc 3 , 78.Xr setlocale 3 , 79.Xr wctob 3 80.\" ---------------------------------------------------------------------- 81.Sh STANDARDS 82The 83.Fn btowc 84function conforms to 85.\" .St -isoC-amd1 . 86ISO/IEC 9899/AMD1:1995 87.Pq Dq ISO C90, Amendment 1 . 88