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. 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 .\"     @(#)fgets.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: head/lib/libc/stdio/fgetws.3 165903 2007-01-09 00:28:16Z imp $
  34 .\"
  35 .Dd December 26, 2013
  36 .Dt FGETWS 3
  37 .Os
  38 .Sh NAME
  39 .Nm fgetws ,
  40 .Nm fgetws_l
  41 .Nd get a line of wide characters from a stream
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In stdio.h
  46 .In wchar.h
  47 .Ft "wchar_t *"
  48 .Fn fgetws "wchar_t * restrict ws" "int n" "FILE * restrict fp"
  49 .In xlocale.h
  50 .Ft "wchar_t *"
  51 .Fn fgetws_l "wchar_t * restrict ws" "int n" "FILE * restrict fp" "locale_t locale"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn fgetws
  55 and
  56 .Fn fgetws_l
  57 functions read at most one less than the number of characters specified by
  58 .Fa n
  59 from the given
  60 .Fa fp
  61 and store 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 .Pp
  70 The
  71 .Fn fgetws_l
  72 function takes an explicit
  73 .Fa locale
  74 argument, whereas the
  75 .Fn fgetws
  76 function uses the current global or per-thread locale.
  77 .Sh RETURN VALUES
  78 Upon successful completion,
  79 .Fn fgetws
  80 and
  81 .Fn fgetws_l
  82 return
  83 .Fa ws .
  84 If end-of-file occurs before any characters are read,
  85 .Fn fgetws
  86 and
  87 .Fn fgetws_l
  88 return
  89 .Dv NULL
  90 and the buffer contents remain unchanged.
  91 If an error occurs,
  92 .Fn fgetws
  93 and
  94 .Fn fgetws_l
  95 return
  96 .Dv NULL
  97 and the buffer contents are indeterminate.
  98 The
  99 .Fn fgetws
 100 and
 101 .Fn fgetws_l
 102 functions
 103 do not distinguish between end-of-file and error, and callers must use
 104 .Xr feof 3
 105 and
 106 .Xr ferror 3
 107 to determine which occurred.
 108 .Sh ERRORS
 109 The
 110 .Fn fgetws
 111 and
 112 .Fn fgetws_l
 113 functions will fail if:
 114 .Bl -tag -width Er
 115 .It Bq Er EBADF
 116 The given
 117 .Fa fp
 118 argument is not a readable stream.
 119 .It Bq Er EILSEQ
 120 The data obtained from the input stream does not form a valid
 121 multibyte character.
 122 .El
 123 .Pp
 124 The functions
 125 .Fn fgetws
 126 and
 127 .Fn fgetws_l
 128 may also fail and set
 129 .Va errno
 130 for any of the errors specified for the routines
 131 .Xr fflush 3 ,
 132 .Xr fstat 2 ,
 133 .Xr read 2 ,
 134 or
 135 .Xr malloc 3 .
 136 .Sh SEE ALSO
 137 .Xr feof 3 ,
 138 .Xr ferror 3 ,
 139 .Xr fgets 3 ,
 140 .Xr xlocale 3
 141 .Sh STANDARDS
 142 The
 143 .Fn fgetws
 144 function
 145 conforms to
 146 .St -p1003.1-2001 .