fgetws(3)                                                     fgetws(3)

  fgetws()

  NAME

    fgetws() - get a wide-character line of from a stream

  SYNOPSIS

    #include 
    #include 

    wchar_t * fgetws (wchar_t *str, size_t size, FILE *stream)

  DESCRIPTION

    The fgetws(3) function reads at most one less than the number of
    characters specified by size from the given stream and stores them in the
    wide-character string str. Reading stops when a newline character is
    found, at end-of-file or error. The newline, if any, is retained. In any
    case a \0 wide-character code is appended to end the string.

  RETURN VALUES

    Upon successful completion, fgetws(3) returns a pointer to the wide-
    character string. If end-of-file or an error occurs before any characters
    are read, they return NULL. The fgetws(3) function does not distinguish
    between end-of-file and error, and callers must use feof(3) and ferror(3)
    to determine which occurred.

  ERRORS

    [EBADF]
        The given stream is not a readable stream.

    The function fgetws(3) may also fail and set errno for any of the errors
    specified for the routines fflush(3), fstat(2), read(2) or malloc(3).

    The function fgetws(3) may also fail and set errno for any of the errors
    specified for the routine getwchar(3).

  SEE ALSO

    feof(3)

    ferror(3)

  USAGE NOTES

    The fgetws function is thread safe.

    The fgetws function is not async-signal safe.