xref: /dflybsd-src/lib/libc/stdio/putwc.3 (revision 488efff854f4f6754b414f28491acc89566d6609)

.\"	$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: src/lib/libc/stdio/putwc.3,v 1.8 2007/01/09 00:28:07 imp Exp $
.\"
.Dd December 25, 2013
.Dt PUTWC 3
.Os
.Sh NAME
.Nm fputwc ,
.Nm fputwc_l ,
.Nm putwc ,
.Nm putwc_l ,
.Nm putwchar ,
.Nm putwchar_l
.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"
.In xlocale.h
.Ft wint_t
.Fn fputwc_l "wchar_t wc" "FILE *stream" "locale_t locale"
.Ft wint_t
.Fn putwc_l "wchar_t wc" "FILE *stream" "locale_t locale"
.Ft wint_t
.Fn putwchar_l "wchar_t wc" "locale_t locale"
.Sh DESCRIPTION
The
.Fn fputwc
and
.Fn fputwc_l
functions write the wide character
.Fa wc
to the output stream pointed to by
.Fa stream .
.Pp
The
.Fn putwc
and
.Fn putwc_l
functions act essentially identically to
.Fn fputwc
and
.Fn fputwc_l .
.Pp
The
.Fn putwchar
and
.Fn putwchar_l
functions are identical to
.Fn putwc
and
.Fn putwc_l
with an output stream of
.Dv stdout .
.Pp
The
.Fn fputwc_l ,
.Fn putwc_l ,
and
.Fn putwchar_l
functions take an explicit
.Fa locale
argument, whereas the
.Fn fputwc ,
.Fn putwc ,
and
.Fn putwchar
functions use the current global or per-thread locale.
.Sh RETURN VALUES
The
.Fn fputwc ,
.Fn fputwc_l ,
.Fn putwc ,
.Fn putwc_l ,
.Fn putwchar ,
and
.Fn putwchar_l
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 ,
.Xr xlocale 3
.Sh STANDARDS
The
.Fn fputwc ,
.Fn putwc ,
and
.Fn putwchar
functions
conform to
.St -isoC-99 .