xref: /original-bsd/lib/libc/stdio/gets.3 (revision cf2124ff)
Copyright (c) 1989 The Regents of the University of California.
All rights reserved.

%sccs.include.redist.man%

@(#)gets.3 6.4 (Berkeley) 06/23/90

GETS 3 ""
.AT 3
NAME
gets - get a line from stdin
SYNOPSIS
#include <stdio.h>

char *gets(s)
char *s;
DESCRIPTION
This interface is obsoleted by fgets(3). As it makes no effort to avoid overwriting its buffer, it's a clear security problem.

It is available from the compatibility library, libcompat.

The gets function reads characters from the input stream pointed to by stdin , into the array pointed to by s , until end-of-file is encountered or a new-line character is read. Any newline character is discarded, and a null character is written immediately after the last character read into the array.

The gets function returns s if successful. If end-of-file is encountered and no characters have been read into the array, the contents of the array remain unchanged and a null pointer is returned. If a read error occurrs during the operation, the array contents are indeterminate and a null pointer is returned.

"SEE ALSO"
getc(3), ferror(3) fread(3), scanf(3)
STANDARDS
The gets function is ANSI C compatible.