fgetstr

Calc Software Package for Number Calc

NAME
    fgetstr - read the next null-terminated string from a file

SYNOPSIS
    fgetstr(fs)

TYPES
    fs		file stream open for reading

    return	string, null or error value

DESCRIPTION
    If the stream is at end of file, the null value is returned.

    If the stream cannot be read, an error value is returned.

    Otherwise the function returns the string of characters from the
    current file position to the first null character ('\0') (the file
    position for further reading then being immediately after the '\0'),
    or if no null character is encountered, the string of characters to
    the end of file (the string as usual being terminated by '\0').

    If the stream being read is from stdin (i.e. files(0)), the
    characters entered are not displayed and reading ends when a '\0' is
    entered (on many terminals this is by ctrl-@).

EXAMPLE
    ; f = fopen("/tmp/junk", "w")
    ; fputstr(f, "  Alpha    Beta ", "", "Gamma\n\tDelta")
    ; freopen(f, "r")
    ; fgetstr(f)
	"  Alpha    Beta "
    ; fgetstr(f)
	""
    ; fgetstr(f)
	"Gamma
	Delta"
    ; fgetstr(f)

LIMITS
    none

LINK LIBRARY
    none

SEE ALSO
    fputstr, fgetword, fgets, fputs, fopen, files, fprintf

## Copyright (C) 1999-2006  Landon Curt Noll
##
## Calc is open software; you can redistribute it and/or modify it under
## the terms of the version 2.1 of the GNU Lesser General Public License
## as published by the Free Software Foundation.
##
## Calc is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
## or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU Lesser General
## Public License for more details.
##
## A copy of version 2.1 of the GNU Lesser General Public License is
## distributed with calc under the filename COPYING-LGPL.  You should have
## received a copy with calc; if not, write to Free Software Foundation, Inc.
## 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
##
## @(#) $Revision: 29.5 $
## @(#) $Id: fgetstr,v 29.5 2006/06/25 22:16:55 chongo Exp $
## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/fgetstr,v $
##
## Under source code control:	1996/04/30 03:05:17
## File existed as early as:	1996
##
## chongo <was here> /\oo/\	http://www.isthe.com/chongo/
## Share and enjoy!  :-)	http://www.isthe.com/chongo/tech/comp/calc/