NAME
getline, getdelim - delimited string input
SYNOPSIS
#define _GNU_SOURCE
#include <stdio.h>
I ssize_t getline(char ** lineptr , size_t * n , FILE * stream );
I ssize_t getdelim(char ** lineptr , size_t * n , int delim , FILE * stream );
DESCRIPTION
R getline ()
reads an entire line from
stream,
storing the address of the buffer containing the text into
R *lineptr .
The buffer is null-terminated and includes the newline character, if
one was found.
If
R *lineptr
is NULL, then
R getline ()
will allocate a buffer for storing the line,
which should be freed by the user program.
(The value in
*n
is ignored.)
Alternatively, before calling
R getline (),
R *lineptr
can contain a pointer to a
malloc(3)\-allocated
buffer
R *n
bytes in size.
If the buffer is not large enough to hold the line,
R getline ()
resizes it with
realloc(3),
updating
R *lineptr
and
R *n
as necessary.
In either case, on a successful call,
R *lineptr
and
R *n
will be updated to reflect the buffer address and allocated size respectively.
R getdelim ()
works like
R getline (),
except a line delimiter other than newline can be specified as the
R delimiter
argument.
As with
R getline (),
a delimiter character is not added if one was not present
in the input before end of file was reached.
RETURN VALUE
On success,
R getline ()
and
R getdelim ()
return the number of characters read, including the delimiter character,
but not including the terminating null byte.
This value can be used
to handle embedded null bytes in the line read.
Both functions return -1 on failure to read a line (including end of file
condition).
ERRORS
EINVAL
Bad parameters
(n
or
lineptr
is NULL, or
stream
is not valid).
CONFORMING TO
Both
R getline ()
and
R getdelim ()
are GNU extensions.
They are available since libc 4.6.27.
EXAMPLE
#define _GNU_SOURCE
#include <stdio.h>
#include <stdlib.h>
int
main(void)
{
FILE * fp;
char * line = NULL;
size_t len = 0;
ssize_t read;
fp = fopen("/etc/motd", "r");
if (fp == NULL)
exit(EXIT_FAILURE);
while ((read = getline(&line, &len, fp)) != -1) {
printf("Retrieved line of length %zu :\n", read);
printf("%s", line);
}
if (line)
free(line);
return EXIT_SUCCESS;
}
SEE ALSO