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	.\" 3. All advertising materials mentioning features or use of this software
	17	.\" must display the following acknowledgement:
	18	.\" This product includes software developed by the University of
	19	.\" California, Berkeley and its contributors.
	20	.\" 4. Neither the name of the University nor the names of its contributors
	21	.\" may be used to endorse or promote products derived from this software
	22	.\" without specific prior written permission.
	23	.\"
	24	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	.\" SUCH DAMAGE.
	35	.\"
	36	.\" @(#)fputs.3 8.1 (Berkeley) 6/4/93
	37	.\" FreeBSD: src/lib/libc/stdio/fputs.3,v 1.8 2001/10/01 16:08:59 ru Exp
	38	.\" $FreeBSD: src/lib/libc/stdio/fputws.3,v 1.5 2003/05/22 13:02:27 ru Exp $
	39	.\"
	40	.Dd August 6, 2002
	41	.Dt FPUTWS 3
	42	.Os
	43	.Sh NAME
	44	.Nm fputws
	45	.Nd output a line of wide characters to a stream
	46	.Sh LIBRARY
	47	.Lb libc
	48	.Sh SYNOPSIS
	49	.In stdio.h
	50	.In wchar.h
	51	.Ft int
	52	.Fn fputws "const wchar_t * restrict ws" "FILE * restrict fp"
	53	.Sh DESCRIPTION
	54	The
	55	.Fn fputws
	56	function writes the wide character string pointed to by
	57	.Fa ws
	58	to the stream pointed to by
	59	.Fa fp .
	60	.Sh RETURN VALUES
	61	The
	62	.Fn fputws
	63	function
	64	returns 0 on success and \-1 on error.
	65	.Sh ERRORS
	66	The
	67	.Fn fputws
	68	function will fail if:
	69	.Bl -tag -width Er
	70	.It Bq Er EBADF
	71	The
	72	.Fa fp
	73	argument supplied
	74	is not a writable stream.
	75	.El
	76	.Pp
	77	The
	78	.Fn fputws
	79	function may also fail and set
	80	.Va errno
	81	for any of the errors specified for the routine
	82	.Xr write 2 .
	83	.Sh SEE ALSO
	84	.Xr ferror 3 ,
	85	.Xr fputs 3 ,
	86	.Xr putwc 3 ,
	87	.Xr stdio 3
	88	.Sh STANDARDS
	89	The
	90	.Fn fputws
	91	function conforms to
	92	.St -p1003.1-2001 .