]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man3/putwchar.3
Many pages: Use correct letter case in page titles (TH)
[thirdparty/man-pages.git] / man3 / putwchar.3
1 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
2 .\"
3 .\" SPDX-License-Identifier: GPL-2.0-or-later
4 .\"
5 .\" References consulted:
6 .\" GNU glibc-2 source code and manual
7 .\" Dinkumware C library reference http://www.dinkumware.com/
8 .\" OpenGroup's Single UNIX specification
9 .\" http://www.UNIX-systems.org/online.html
10 .\" ISO/IEC 9899:1999
11 .\"
12 .TH putwchar 3 (date) "Linux man-pages (unreleased)"
13 .SH NAME
14 putwchar \- write a wide character to standard output
15 .SH LIBRARY
16 Standard C library
17 .RI ( libc ", " \-lc )
18 .SH SYNOPSIS
19 .nf
20 .B #include <wchar.h>
21 .PP
22 .BI "wint_t putwchar(wchar_t " wc );
23 .fi
24 .SH DESCRIPTION
25 The
26 .BR putwchar ()
27 function is the wide-character equivalent of the
28 .BR putchar (3)
29 function.
30 It writes the wide character
31 .I wc
32 to
33 .IR stdout .
34 If
35 .I ferror(stdout)
36 becomes true, it returns
37 .BR WEOF .
38 If a wide character
39 conversion error occurs, it sets
40 .I errno
41 to
42 .B EILSEQ
43 and returns
44 .BR WEOF .
45 Otherwise, it returns
46 .IR wc .
47 .PP
48 For a nonlocking counterpart, see
49 .BR unlocked_stdio (3).
50 .SH RETURN VALUE
51 The
52 .BR putwchar ()
53 function returns
54 .I wc
55 if no error occurred, or
56 .B WEOF
57 to indicate an error.
58 .SH ATTRIBUTES
59 For an explanation of the terms used in this section, see
60 .BR attributes (7).
61 .ad l
62 .nh
63 .TS
64 allbox;
65 lbx lb lb
66 l l l.
67 Interface Attribute Value
68 T{
69 .BR putwchar ()
70 T} Thread safety MT-Safe
71 .TE
72 .hy
73 .ad
74 .sp 1
75 .SH STANDARDS
76 POSIX.1-2001, POSIX.1-2008, C99.
77 .SH NOTES
78 The behavior of
79 .BR putwchar ()
80 depends on the
81 .B LC_CTYPE
82 category of the
83 current locale.
84 .PP
85 It is reasonable to expect that
86 .BR putwchar ()
87 will actually write
88 the multibyte sequence corresponding to the wide character
89 .IR wc .
90 .SH SEE ALSO
91 .BR fputwc (3),
92 .BR unlocked_stdio (3)