Blame man3/btowc.3

Packit 7cfc04
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
Packit 7cfc04
.\" This is free documentation; you can redistribute it and/or
Packit 7cfc04
.\" modify it under the terms of the GNU General Public License as
Packit 7cfc04
.\" published by the Free Software Foundation; either version 2 of
Packit 7cfc04
.\" the License, or (at your option) any later version.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" References consulted:
Packit 7cfc04
.\"   GNU glibc-2 source code and manual
Packit 7cfc04
.\"   Dinkumware C library reference http://www.dinkumware.com/
Packit 7cfc04
.\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
Packit 7cfc04
.\"   ISO/IEC 9899:1999
Packit 7cfc04
.\"
Packit 7cfc04
.TH BTOWC 3 2015-08-08 "GNU" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
btowc \- convert single byte to wide character
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <wchar.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "wint_t btowc(int " c );
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR btowc ()
Packit 7cfc04
function converts \fIc\fP,
Packit 7cfc04
interpreted as a multibyte sequence
Packit 7cfc04
of length 1, starting in the initial shift state, to a wide character and
Packit 7cfc04
returns it.
Packit 7cfc04
If \fIc\fP is
Packit 7cfc04
.B EOF
Packit 7cfc04
or not a valid multibyte sequence of length 1,
Packit 7cfc04
the
Packit 7cfc04
.BR btowc ()
Packit 7cfc04
function returns
Packit 7cfc04
.BR WEOF .
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
The
Packit 7cfc04
.BR btowc ()
Packit 7cfc04
function returns the wide character
Packit 7cfc04
converted from the single byte \fIc\fP.
Packit 7cfc04
If \fIc\fP is
Packit 7cfc04
.B EOF
Packit 7cfc04
or not a valid multibyte sequence of length 1,
Packit 7cfc04
it returns
Packit 7cfc04
.BR WEOF .
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR btowc ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
POSIX.1-2001, POSIX.1-2008, C99.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
The behavior of
Packit 7cfc04
.BR btowc ()
Packit 7cfc04
depends on the
Packit 7cfc04
.B LC_CTYPE
Packit 7cfc04
category of the
Packit 7cfc04
current locale.
Packit 7cfc04
.PP
Packit 7cfc04
This function should never be used.
Packit 7cfc04
It does not work for encodings which have
Packit 7cfc04
state, and unnecessarily treats single bytes differently from multibyte
Packit 7cfc04
sequences.
Packit 7cfc04
Use either
Packit 7cfc04
.BR mbtowc (3)
Packit 7cfc04
or the thread-safe
Packit 7cfc04
.BR mbrtowc (3)
Packit 7cfc04
instead.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR mbrtowc (3),
Packit 7cfc04
.BR mbtowc (3),
Packit 7cfc04
.BR wctob (3)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.