getwc.3 (c879ae3536e6d92b8d96c8965c5b05fcb9541520) getwc.3 (01533af5a0f742541d5c97c54c9f3e766fcd5ce8)
1.\" $NetBSD: getwc.3,v 1.3 2002/02/07 07:00:26 ross Exp $
2.\"
3.\" Copyright (c) 1990, 1991, 1993
4.\" The Regents of the University of California. All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Chris Torek and the American National Standards Committee X3,
8.\" on Information Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\" notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\" notice, this list of conditions and the following disclaimer in the
17.\" documentation and/or other materials provided with the distribution.
1.\" $NetBSD: getwc.3,v 1.3 2002/02/07 07:00:26 ross Exp $
2.\"
3.\" Copyright (c) 1990, 1991, 1993
4.\" The Regents of the University of California. All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Chris Torek and the American National Standards Committee X3,
8.\" on Information Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\" notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\" notice, this list of conditions and the following disclaimer in the
17.\" documentation and/or other materials provided with the distribution.
18.\" 3. All advertising materials mentioning features or use of this software
19.\" must display the following acknowledgement:
20.\" This product includes software developed by the University of
21.\" California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\" may be used to endorse or promote products derived from this software
20.\" without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" @(#)getc.3 8.1 (Berkeley) 6/4/93
35.\" $FreeBSD$
36.\"
22.\" 4. Neither the name of the University nor the names of its contributors
23.\" may be used to endorse or promote products derived from this software
24.\" without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.\" @(#)getc.3 8.1 (Berkeley) 6/4/93
39.\" $FreeBSD$
40.\"
37.Dd March 3, 2004
41.Dd October 24, 2001
38.Dt GETWC 3
39.Os
40.Sh NAME
41.Nm fgetwc ,
42.Nm getwc ,
42.Dt GETWC 3
43.Os
44.Sh NAME
45.Nm fgetwc ,
46.Nm getwc ,
43.Nm getwchar
44.Nd get next wide character from input stream
47.Nm getwchar ,
48.Nd get next wide-character from input stream
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
49.Sh LIBRARY
50.Lb libc
51.Sh SYNOPSIS
48.In stdio.h
49.In wchar.h
52.Fd #include \*[Lt]stdio.h\*[Gt]
53.Fd #include \*[Lt]wchar.h\*[Gt]
50.Ft wint_t
51.Fn fgetwc "FILE *stream"
52.Ft wint_t
53.Fn getwc "FILE *stream"
54.Ft wint_t
54.Ft wint_t
55.Fn fgetwc "FILE *stream"
56.Ft wint_t
57.Fn getwc "FILE *stream"
58.Ft wint_t
55.Fn getwchar void
59.Fn getwchar
56.Sh DESCRIPTION
57The
58.Fn fgetwc
59function
60.Sh DESCRIPTION
61The
62.Fn fgetwc
63function
60obtains the next input wide character (if present) from the stream pointed at by
64obtains the next input wide-character (if present) from the stream pointed at by
61.Fa stream ,
62or the next character pushed back on the stream via
63.Xr ungetwc 3 .
64.Pp
65The
66.Fn getwc
67function
68acts essentially identically to
65.Fa stream ,
66or the next character pushed back on the stream via
67.Xr ungetwc 3 .
68.Pp
69The
70.Fn getwc
71function
72acts essentially identically to
69.Fn fgetwc .
73.Fn fgetwc ,
74but is a macro that expands in-line.
70.Pp
71The
72.Fn getwchar
73function
74is equivalent to
75.Fn getwc
75.Pp
76The
77.Fn getwchar
78function
79is equivalent to
80.Fn getwc
76with the argument
77.Dv stdin .
81with the argument stdin.
78.Sh RETURN VALUES
82.Sh RETURN VALUES
79If successful, these routines return the next wide character
83If successful, these routines return the next wide-character
80from the
81.Fa stream .
82If the stream is at end-of-file or a read error occurs,
83the routines return
84.Dv WEOF .
85The routines
86.Xr feof 3
87and

--- 6 unchanged lines hidden (view full) ---

94subsequent attempts to read will return
95.Dv WEOF
96until the condition is cleared with
97.Xr clearerr 3 .
98.Sh SEE ALSO
99.Xr ferror 3 ,
100.Xr fopen 3 ,
101.Xr fread 3 ,
84from the
85.Fa stream .
86If the stream is at end-of-file or a read error occurs,
87the routines return
88.Dv WEOF .
89The routines
90.Xr feof 3
91and

--- 6 unchanged lines hidden (view full) ---

98subsequent attempts to read will return
99.Dv WEOF
100until the condition is cleared with
101.Xr clearerr 3 .
102.Sh SEE ALSO
103.Xr ferror 3 ,
104.Xr fopen 3 ,
105.Xr fread 3 ,
102.Xr getc 3 ,
103.Xr putwc 3 ,
104.Xr stdio 3 ,
105.Xr ungetwc 3
106.Sh STANDARDS
107The
108.Fn fgetwc ,
109.Fn getwc
110and
111.Fn getwchar
112functions
113conform to
106.Xr putwc 3 ,
107.Xr stdio 3 ,
108.Xr ungetwc 3
109.Sh STANDARDS
110The
111.Fn fgetwc ,
112.Fn getwc
113and
114.Fn getwchar
115functions
116conform to
114.St -isoC-99 .
117.St -isoC99 .