1.\" Copyright (c) 2002 Tim J. Robbins 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD: head/lib/libc/locale/btowc.3 248803 2013-03-27 21:31:40Z jilles $ 26.\" 27.Dd February 13, 2012 28.Dt BTOWC 3 29.Os 30.Sh NAME 31.Nm btowc , btowc_l , 32.Nm wctob , wctob_l 33.Nd "convert between wide and single-byte characters" 34.Sh LIBRARY 35.Lb libc 36.Sh SYNOPSIS 37.In wchar.h 38.Ft wint_t 39.Fn btowc "int c" 40.Ft int 41.Fn wctob "wint_t c" 42.In wchar.h 43.In xlocale.h 44.Ft wint_t 45.Fn btowc_l "int c" "locale_t loc" 46.Ft int 47.Fn wctob_l "wint_t c" "locale_t loc" 48.Sh DESCRIPTION 49The 50.Fn btowc 51function converts a single-byte character into a corresponding wide character. 52If the character is 53.Dv EOF 54or not valid in the initial shift state, 55.Fn btowc 56returns 57.Dv WEOF . 58.Pp 59The 60.Fn wctob 61function converts a wide character into a corresponding single-byte character. 62If the wide character is 63.Dv WEOF 64or not able to be represented as a single byte in the initial shift state, 65.Fn wctob 66returns 67.Dv EOF . 68.Pp 69The _l-suffixed versions take an explicit locale argument, while the 70non-suffixed versions use the current global or per-thread locale. 71.Sh SEE ALSO 72.Xr mbrtowc 3 , 73.Xr multibyte 3 , 74.Xr wcrtomb 3 75.Sh STANDARDS 76The 77.Fn btowc 78and 79.Fn wctob 80functions conform to 81.St -p1003.1-2001 . 82.Sh HISTORY 83The 84.Fn btowc 85and 86.Fn wctob 87functions first appeared in 88.Fx 5.0 . 89