man-pages/man3/btowc.3

58 lines
1.6 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" References consulted:
.\" GNU glibc-2 source code and manual
.\" Dinkumware C library reference http://www.dinkumware.com/
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
.\" ISO/IEC 9899:1999
.\"
.TH BTOWC 3 1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
btowc \- convert single byte to wide character
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.sp
.BI "wint_t btowc(int " c );
.fi
.SH DESCRIPTION
The
.BR btowc ()
function converts \fIc\fP,
interpreted as a multibyte sequence
2004-11-03 13:51:07 +00:00
of length 1, starting in the initial shift state, to a wide character and
returns it.
If \fIc\fP is EOF or not a valid multibyte sequence of length 1,
the
.BR btowc ()
function returns WEOF.
2004-11-03 13:51:07 +00:00
.SH "RETURN VALUE"
The
.BR btowc ()
function returns the wide character
converted from the single byte \fIc\fP.
If \fIc\fP is EOF or not a valid multibyte sequence of length 1,
2004-11-03 13:51:07 +00:00
it returns WEOF.
.SH "CONFORMING TO"
C99, POSIX.1-2001.
2004-11-03 13:51:07 +00:00
.SH NOTES
The behaviour of
.BR btowc ()
depends on the LC_CTYPE category of the
2004-11-03 13:51:07 +00:00
current locale.
.PP
This function should never be used.
It does not work for encodings which have
2004-11-03 13:51:07 +00:00
state, and unnecessarily treats single bytes differently from multibyte
sequences.
Use the function
.BR mbtowc ()
instead.
2007-05-16 18:25:50 +00:00
.SH "SEE ALSO"
.BR mbtowc (3)