GETLINE(3) Linux Programmer's Manual GETLINE(3)

NAME
       getline, getdelim - delimited string input

SYNOPSIS
       #include 

       ssizet getline(char **lineptr, sizet *n, FILE *stream);

       ssizet getdelim(char **lineptr, sizet *n, int delim, FILE *stream);

   Feature Test Macro Requirements for glibc (see featuretestmacros(7)):

       getline(), getdelim():
           Since glibc 2.10:
               POSIXCSOURCE >= 200809L || XOPENSOURCE >= 700
           Before glibc 2.10:
               GNUSOURCE

DESCRIPTION
       getline()  reads an entire line from stream, storing the address of the
       buffer containing the text into *lineptr.  The  buffer  is  null-termi‐
       nated and includes the newline character, if one was found.

       If  *lineptr is NULL, then getline() will allocate a buffer for storing
       the line, which should be freed by the user program.   (In  this  case,
       the value in *n is ignored.)

       Alternatively, before calling getline(), *lineptr can contain a pointer
       to a malloc(3)-allocated buffer *n bytes in size.  If the buffer is not
       large  enough  to  hold the line, getline() resizes it with realloc(3),
       updating *lineptr and *n as necessary.

       In either case, on a successful call, *lineptr and *n will  be  updated
       to reflect the buffer address and allocated size respectively.

       getdelim()  works  like  getline(),  except that a line delimiter other
       than newline can be specified as the delimiter argument.  As with  get‐
       line(),  a  delimiter  character is not added if one was not present in
       the input before end of file was reached.

RETURN VALUE
       On success, getline() and getdelim() return the  number  of  characters
       read,  including  the delimiter character, but not including the termi‐
       nating null byte ('\0').  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).  In the event of an error, errno is  set  to  indicate
       the cause.

ERRORS
       EINVAL Bad arguments (n or lineptr is NULL, or stream is not valid).

VERSIONS
       These functions are available since libc 4.6.27.

CONFORMING TO
       Both  getline()  and  getdelim()  were originally GNU extensions.  They
       were standardized in POSIX.1-2008.

EXAMPLE
       #define GNUSOURCE
       #include 
       #include 

       int
       main(void)
       {
           FILE *fp;
           char *line = NULL;
           sizet len = 0;
           ssizet read;

           fp = fopen("/etc/motd", "r");
           if (fp == NULL)
               exit(EXITFAILURE);

           while ((read = getline(&line, &len, fp)) != -1) {
               printf("Retrieved line of length %zu :\n", read);
               printf("%s", line);
           }

           free(line);
           exit(EXITSUCCESS);
       }

SEE ALSO
       read(2), fgets(3), fopen(3), fread(3), gets(3), scanf(3)

COLOPHON
       This page is part of release 3.53 of the Linux  man-pages  project.   A
       description  of  the project, and information about reporting bugs, can
       be found at http://www.kernel.org/doc/man-pages/.



GNU                               2013-04-19                        GETLINE(3)