summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2017/man3p/btowc.3p
blob: 54122eab7bc508533dcf9423baa0705e7d6fc844 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
'\" et
.TH BTOWC "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
btowc
\(em single byte to wide character conversion
.SH SYNOPSIS
.LP
.nf
#include <stdio.h>
#include <wchar.h>
.P
wint_t btowc(int \fIc\fP);
.fi
.SH DESCRIPTION
The functionality described on this reference page is aligned with the
ISO\ C standard. Any conflict between the requirements described here and the
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
.P
The
\fIbtowc\fR()
function shall determine whether
.IR c
constitutes a valid (one-byte) character in the initial shift state.
.P
The behavior of this function shall be affected by the
.IR LC_CTYPE
category of the current locale.
.SH "RETURN VALUE"
The
\fIbtowc\fR()
function shall return WEOF if
.IR c
has the value EOF or if
.BR "(unsigned char)"
.IR c
does not constitute a valid (one-byte) character in the initial shift
state. Otherwise, it shall return the wide-character representation of
that character.
.P
In the POSIX locale,
\fIbtowc\fR()
shall not return WEOF if
.IR c
has a value in the range 0 to 255 inclusive.
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIwctob\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<stdio.h>\fP",
.IR "\fB<wchar.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version 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 .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .