lib/libc/stdio/fgetws.3

   1 .\" $NetBSD: fgetws.3,v 1.2 2003/08/07 16:43:23 agc Exp $
   2 .\" $DragonFly: src/lib/libc/stdio/fgetws.3,v 1.1 2005/07/25 00:37:41 joerg Exp $
   3 .\"
   4 .\" Copyright (c) 1990, 1991, 1993
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" This code is derived from software contributed to Berkeley by
   8 .\" Chris Torek and the American National Standards Committee X3,
   9 .\" on Information Processing Systems.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)fgets.3     8.1 (Berkeley) 6/4/93
  36 .\"
  37 .\" Original version ID:
  38 .\" FreeBSD: src/lib/libc/stdio/fgets.3,v 1.16 2002/05/31 05:01:17 archie Exp
  39 .\" FreeBSD: src/lib/libc/stdio/fgetws.3,v 1.2 2002/09/06 11:23:55 tjr Exp
  40 .\"
  41 .Dd August 6, 2002
  42 .Dt FGETWS 3
  43 .Os
  44 .Sh NAME
  45 .Nm fgetws
  46 .Nd get a line of wide characters from a stream
  47 .Sh LIBRARY
  48 .Lb libc
  49 .Sh SYNOPSIS
  50 .In stdio.h
  51 .In wchar.h
  52 .Ft "wchar_t *"
  53 .Fn fgetws "wchar_t * restrict ws" "int n" "FILE * restrict fp"
  54 .Sh DESCRIPTION
  55 The
  56 .Fn fgetws
  57 function
  58 reads at most one less than the number of characters specified by
  59 .Fa n
  60 from the given
  61 .Fa fp
  62 and stores them in the wide character string
  63 .Fa ws .
  64 Reading stops when a newline character is found,
  65 at end-of-file or error.
  66 The newline, if any, is retained.
  67 If any characters are read and there is no error, a
  68 .Ql \e0
  69 character is appended to end the string.
  70 .Sh RETURN VALUES
  71 Upon successful completion,
  72 .Fn fgetws
  73 returns
  74 .Fa ws .
  75 If end-of-file occurs before any characters are read,
  76 .Fn fgetws
  77 returns
  78 .Dv NULL
  79 and the buffer contents remain unchanged.
  80 If an error occurs,
  81 .Fn fgetws
  82 returns
  83 .Dv NULL
  84 and the buffer contents are indeterminate.
  85 The
  86 .Fn fgetws
  87 function
  88 does not distinguish between end-of-file and error, and callers must use
  89 .Xr feof 3
  90 and
  91 .Xr ferror 3
  92 to determine which occurred.
  93 .Sh ERRORS
  94 .Bl -tag -width Er
  95 .It Bq Er EBADF
  96 The given
  97 .Fa fp
  98 argument is not a readable stream.
  99 .It Bq Er EILSEQ
 100 The data obtained from the input stream does not form a valid
 101 multibyte character.
 102 .El
 103 .Pp
 104 The function
 105 .Fn fgetws
 106 may also fail and set
 107 .Va errno
 108 for any of the errors specified for the routines
 109 .Xr fflush 3 ,
 110 .Xr fstat 2 ,
 111 .Xr read 2 ,
 112 or
 113 .Xr malloc 3 .
 114 .Sh SEE ALSO
 115 .Xr feof 3 ,
 116 .Xr ferror 3 ,
 117 .Xr fgets 3
 118 .Sh STANDARDS
 119 The
 120 .Fn fgetws
 121 function
 122 conforms to
 123 .St -p1003.1-2001 .