Return to fgets.3 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / lib / libc / stdio

Annotation of 43BSDReno/lib/libc/stdio/fgets.3, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1989 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"    @(#)fgets.3     6.4 (Berkeley) 6/23/90
                     19: .\"
                     20: .TH FGETS 3 "June 23, 1990"
                     21: .AT 3
                     22: .SH NAME
                     23: fgets - get a line from a stream
                     24: .SH SYNOPSIS
                     25: .nf
                     26: .B #include <stdio.h>
                     27: 
                     28: .B char *fgets(s, n, stream)
                     29: .B char *s;
                     30: .B int n;
                     31: .B FILE *stream;
                     32: .fi
                     33: .SH DESCRIPTION
                     34: The
                     35: .I fgets
                     36: function reads at most one less than the number of characters specified
                     37: by
                     38: .I n
                     39: from the stream pointed to by
                     40: .I stream
                     41: into the array pointed to by
                     42: .IR s .
                     43: No additional characters are read after a new-line character
                     44: (which is retained) or after end-of-file.
                     45: A null character is written immediately after the last character
                     46: read into the array.
                     47: .PP
                     48: The
                     49: .I fgets
                     50: function returns
                     51: .I s
                     52: if successful.
                     53: If end-of-file is encountered and no characters have been read
                     54: into the array, the contents of the array remain unchanged and
                     55: a null pointer is returned.
                     56: If a read error occurs during the operation, the array contents
                     57: are indeterminate and a null pointer is returned.
                     58: .SH "SEE ALSO"
                     59: getc(3), ferror(3) fread(3), scanf(3)
                     60: .SH STANDARDS
                     61: The
                     62: .I fgets
                     63: function is ANSI C compatible.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.