hpux man page for fgetws

fgetws(3C)																fgetws(3C)

NAME
       fgetws(), fgetws_unlocked() - get a wide-character string from a stream file

SYNOPSIS
   Obsolescent Interface
   Remarks
       is  compliant  with  the  XPG4 Worldwide Portability Interface wide-character I/O functions.  It parallels the 8-bit character I/O function
       defined in gets(3S).

DESCRIPTION
       Reads characters from the
		      stream, converts them into corresponding wide characters, and places them into the array pointed to by ws, until n - 1 char-
		      acters  are  read,  a newline character is read and transferred to ws, or an end-of-file condition is encountered.  The wide
		      string is then terminated with a null wide character.

       The definition for this functions and the type are provided in the header.

   Obsolescent Interface
       get a wide-character string from a stream file.

APPLICATION USAGE
       After is applied to a stream, the stream becomes wide-oriented (see orientation(5)).

EXTERNAL INFLUENCES
   Environment Variables
       determines how wide character conversions are done.

   International Code Set Support
       Single- and multibyte character code sets are supported.

RETURN VALUE
       Upon successful completion, and return ws.  If the stream is at end-of-file, the end-of-file indicator for the stream is  set  and  a  null
       pointer is returned.

       When the file corresponding to the open stream gets extended after the end-of-file is reached, all subsequent calls to these functions will
       succeed and the end-of-file indicator will remain set.  However, in the UNIX2003 standards environment (see standards(5)), these  functions
       will fail, and they will return a null pointer; the end-of-file indicator will still remain set.

       If a read error occurs, the error indicator for the stream is set, is set to indicate the error, and a null pointer is returned.

       or can be used to distinguish between an error condition and an end-of-file condition.

ERRORS
       If or fails if data needs to be read into the stream's buffer and another error occurs, is set to one of the following:

	      The	     flag is set for the file descriptor underlying stream and the process would be delayed in the read operation.

	      The file descriptor underlying
			     stream is not a valid file descriptor open for reading.

	      The read operation was terminated due to the receipt of a signal,
			     and either no data was transferred or the implementation does not report partial transfer for this file.

	      The data obtained from the input stream do not form a valid wide-character
			     string.

	      The process is a member of a background process
			     and is attempting to read from its controlling terminal, and either the process is ignoring or blocking the signal or
			     the process group of the process is orphaned.

       Additional values can be set by the underlying function (see read(2)).

WARNINGS
       is an obsolescent interface supported only for compatibility with existing DCE applications.  New multithreaded applications should use

AUTHOR
       was developed by OSF and HP.

SEE ALSO
       ferror(3S), flockfile(3S), fopen(3S), fread(3S), getwc(3C), putws(3C), scanf(3S),  orientation(5),  standards(5),  thread_safety(5),  glos-
       sary(9).

STANDARDS CONFORMANCE
																	fgetws(3C)