git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	1	.\" Copyright (c) 1990, 1991, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" Chris Torek and the American National Standards Committee X3,
	6	.\" on Information Processing Systems.
	7	.\"
	8	.\" Redistribution and use in source and binary forms, with or without
	9	.\" modification, are permitted provided that the following conditions
	10	.\" are met:
	11	.\" 1. Redistributions of source code must retain the above copyright
	12	.\" notice, this list of conditions and the following disclaimer.
	13	.\" 2. Redistributions in binary form must reproduce the above copyright
	14	.\" notice, this list of conditions and the following disclaimer in the
	15	.\" documentation and/or other materials provided with the distribution.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" @(#)fputs.3 8.1 (Berkeley) 6/4/93
	33	.\" FreeBSD: src/lib/libc/stdio/fputs.3,v 1.8 2001/10/01 16:08:59 ru Exp
	34	.\" $FreeBSD: src/lib/libc/stdio/fputws.3,v 1.6 2007/01/09 00:28:06 imp Exp $
	35	.\"
	36	.Dd August 6, 2002
	37	.Dt FPUTWS 3
	38	.Os
	39	.Sh NAME
	40	.Nm fputws ,
	41	.Nm fputws_l
	42	.Nd output a line of wide characters to a stream
	43	.Sh LIBRARY
	44	.Lb libc
	45	.Sh SYNOPSIS
	46	.In stdio.h
	47	.In wchar.h
	48	.Ft int
	49	.Fo fputws
	50	.Fa "const wchar_t *restrict ws"
	51	.Fa "FILE *restrict stream"
	52	.Fc
	53	.In stdio.h
	54	.In wchar.h
	55	.In xlocale.h
	56	.Ft int
	57	.Fo fputws_l
	58	.Fa "const wchar_t *restrict ws"
	59	.Fa "FILE *restrict stream"
	60	.Fa "locale_t loc"
	61	.Fc
	62	.Sh DESCRIPTION
	63	The
	64	.Fn fputws
	65	function writes the wide character string pointed to by
	66	.Fa ws
	67	to the stream pointed to by
	68	.Fa stream .
	69	.Pp
	70	Although the
	71	.Fn fputws
	72	function uses the current locale, the
	73	.Fn fputws_l
	74	function may be passed a locale directly. See
	75	.Xr xlocale 3
	76	for more information.
	77	.Sh RETURN VALUES
	78	The
	79	.Fn fputws
	80	function
	81	returns 0 on success and \-1 on error.
	82	.Sh ERRORS
	83	The
	84	.Fn fputws
	85	function will fail if:
	86	.Bl -tag -width Er
	87	.It Bq Er EBADF
	88	The
	89	.Fa stream
	90	argument supplied
	91	is not a writable stream.
	92	.El
	93	.Pp
	94	The
	95	.Fn fputws
	96	function may also fail and set
	97	.Va errno
	98	for any of the errors specified for the routine
	99	.Xr write 2 .
	100	.Sh SEE ALSO
	101	.Xr ferror 3 ,
	102	.Xr fputs 3 ,
	103	.Xr putwc 3 ,
	104	.Xr stdio 3 ,
	105	.Xr xlocale 3
	106	.Sh STANDARDS
	107	The
	108	.Fn fputws
	109	function conforms to
	110	.St -p1003.1-2001 .