lib/libc/stdio/fgetws.3

   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 .\"     @(#)fgets.3     8.1 (Berkeley) 6/4/93
  37 .\" FreeBSD: src/lib/libc/stdio/fgets.3,v 1.16 2002/05/31 05:01:17 archie Exp
  38 .\" $FreeBSD$
  39 .\"
  40 .Dd August 6, 2002
  41 .Dt FGETWS 3
  42 .Os
  43 .Sh NAME
  44 .Nm fgetws
  45 .Nd get a line of wide characters from a stream
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In stdio.h
  50 .In wchar.h
  51 .Ft "wchar_t *"
  52 .Fn fgetws "wchar_t * restrict ws" "int n" "FILE * restrict fp"
  53 .Sh DESCRIPTION
  54 The
  55 .Fn fgetws
  56 function
  57 reads at most one less than the number of characters specified by
  58 .Fa n
  59 from the given
  60 .Fa fp
  61 and stores them in the wide character string
  62 .Fa ws .
  63 Reading stops when a newline character is found,
  64 at end-of-file or error.
  65 The newline, if any, is retained.
  66 If any characters are read and there is no error, a
  67 .Ql \e0
  68 character is appended to end the string.
  69 .Sh RETURN VALUES
  70 Upon successful completion,
  71 .Fn fgetws
  72 returns
  73 .Fa ws .
  74 If end-of-file occurs before any characters are read,
  75 .Fn fgetws
  76 returns
  77 .Dv NULL
  78 and the buffer contents remain unchanged.
  79 If an error occurs,
  80 .Fn fgetws
  81 returns
  82 .Dv NULL
  83 and the buffer contents are indeterminate.
  84 The
  85 .Fn fgetws
  86 function
  87 does not distinguish between end-of-file and error, and callers must use
  88 .Xr feof 3
  89 and
  90 .Xr ferror 3
  91 to determine which occurred.
  92 .Sh ERRORS
  93 The
  94 .Fn fgetws
  95 function will fail if:
  96 .Bl -tag -width Er
  97 .It Bq Er EBADF
  98 The given
  99 .Fa fp
 100 argument is not a readable stream.
 101 .It Bq Er EILSEQ
 102 The data obtained from the input stream does not form a valid
 103 multibyte character.
 104 .El
 105 .Pp
 106 The function
 107 .Fn fgetws
 108 may also fail and set
 109 .Va errno
 110 for any of the errors specified for the routines
 111 .Xr fflush 3 ,
 112 .Xr fstat 2 ,
 113 .Xr read 2 ,
 114 or
 115 .Xr malloc 3 .
 116 .Sh SEE ALSO
 117 .Xr feof 3 ,
 118 .Xr ferror 3 ,
 119 .Xr fgets 3
 120 .Sh STANDARDS
 121 The
 122 .Fn fgetws
 123 function
 124 conforms to
 125 .St -p1003.1-2001 .