freebsd-dev/lib/libc/stdio/putwc.3

.\"	$NetBSD: putwc.3,v 1.2 2002/02/07 07:00:26 ross Exp $
.\"
.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)putc.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd March 3, 2004
.Dt PUTWC 3
.Os
.Sh NAME
.Nm fputwc ,
.Nm putwc ,
.Nm putwchar
.Nd output a wide character to a stream
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.In wchar.h
.Ft wint_t
.Fn fputwc "wchar_t wc" "FILE *stream"
.Ft wint_t
.Fn putwc "wchar_t wc" "FILE *stream"
.Ft wint_t
.Fn putwchar "wchar_t wc"
.Sh DESCRIPTION
The
.Fn fputwc
function
writes the wide character
.Fa wc
to the output stream pointed to by
.Fa stream .
.Pp
The
.Fn putwc
function
acts essentially identically to
.Fn fputwc .
.Pp
The
.Fn putwchar
function
is identical to
.Fn putwc
with an output stream of
.Dv stdout .
.Sh RETURN VALUES
The
.Fn fputwc ,
.Fn putwc ,
and
.Fn putwchar
functions
return the wide character written.
If an error occurs, the value
.Dv WEOF
is returned.
.Sh SEE ALSO
.Xr ferror 3 ,
.Xr fopen 3 ,
.Xr getwc 3 ,
.Xr putc 3 ,
.Xr stdio 3
.Sh STANDARDS
The
.Fn fputwc ,
.Fn putwc ,
and
.Fn putwchar
functions
conform to
.St -isoC-99 .
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.\" $NetBSD: putwc.3,v 1.2 2002/02/07 07:00:26 ross Exp $`
			`.\"`
			`.\" Copyright (c) 1990, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" Chris Torek and the American National Standards Committee X3,`
			`.\" on Information Processing Systems.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)putc.3 8.1 (Berkeley) 6/4/93`
			`.\" $FreeBSD$`
			`.\"`
Refer to "wide characters" instead of "wide-characters". 2004-03-16 13:30:11 +00:00			`.Dd March 3, 2004`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Dt PUTWC 3`
			`.Os`
			`.Sh NAME`
			`.Nm fputwc ,`
			`.Nm putwc ,`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`.Nm putwchar`
Refer to "wide characters" instead of "wide-characters". 2004-03-16 13:30:11 +00:00			`.Nd output a wide character to a stream`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Sh LIBRARY`
			`.Lb libc`
			`.Sh SYNOPSIS`
FreeBSD-ify: use In macro for header files in Synopsis, St C-99 instead of St C99 in Standards section. 2002-08-13 10:47:17 +00:00			`.In stdio.h`
			`.In wchar.h`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Ft wint_t`
			`.Fn fputwc "wchar_t wc" "FILE *stream"`
			`.Ft wint_t`
			`.Fn putwc "wchar_t wc" "FILE *stream"`
			`.Ft wint_t`
			`.Fn putwchar "wchar_t wc"`
			`.Sh DESCRIPTION`
			`The`
			`.Fn fputwc`
			`function`
Refer to "wide characters" instead of "wide-characters". 2004-03-16 13:30:11 +00:00			`writes the wide character`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Fa wc`
			`to the output stream pointed to by`
			`.Fa stream .`
			`.Pp`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`The`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Fn putwc`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`function`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`acts essentially identically to`
Cross-reference between byte and wide-character stdio functions. Remove references to fputwc() and fgetwc() being macros while I'm at it. 2002-10-10 04:12:40 +00:00			`.Fn fputwc .`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Pp`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`The`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Fn putwchar`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`function`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`is identical to`
			`.Fn putwc`
			`with an output stream of`
Consistently mark std(in\|out\|err) with .Dv, because that's how they are marked up in stdio(3), and because they are defined expressions of type "FILE *". Approved by: re 2002-12-04 18:57:46 +00:00			`.Dv stdout .`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Sh RETURN VALUES`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`The`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Fn fputwc ,`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`.Fn putwc ,`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`and`
			`.Fn putwchar`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`functions`
Refer to "wide characters" instead of "wide-characters". 2004-03-16 13:30:11 +00:00			`return the wide character written.`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`If an error occurs, the value`
			`.Dv WEOF`
			`is returned.`
			`.Sh SEE ALSO`
			`.Xr ferror 3 ,`
			`.Xr fopen 3 ,`
			`.Xr getwc 3 ,`
Cross-reference putc(3). 2002-10-28 10:35:18 +00:00			`.Xr putc 3 ,`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Xr stdio 3`
			`.Sh STANDARDS`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`The`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`.Fn fputwc ,`
			`.Fn putwc ,`
			`and`
Cross-reference between byte and wide-character stdio functions. Remove references to fputwc() and fgetwc() being macros while I'm at it. 2002-10-10 04:12:40 +00:00			`.Fn putwchar`
mdoc(7) police: markup overhaul. Approved by: re 2002-12-04 17:49:15 +00:00			`functions`
Manual pages for fwide(), getwc(), fgetwc(), getwchar(), putwc(), fputwc(), putwchar(), ungetwc() from NetBSD and Citrus Project, unmodified except for the addition of $FreeBSD$. Obtained from: NetBSD, Citrus Project 2002-08-12 13:23:12 +00:00			`conform to`
FreeBSD-ify: use In macro for header files in Synopsis, St C-99 instead of St C99 in Standards section. 2002-08-13 10:47:17 +00:00			`.St -isoC-99 .`