getline(3)


NAME

   getline, getdelim - delimited string input

SYNOPSIS

   #include <stdio.h>

   ssize_t getline(char **lineptr, size_t *n, FILE *stream);

   ssize_t getdelim(char **lineptr, size_t *n, int delim, FILE *stream);

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

   getline(), getdelim():
       Since glibc 2.10:
           _POSIX_C_SOURCE >= 200809L
       Before glibc 2.10:
           _GNU_SOURCE

DESCRIPTION

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

   If  *lineptr  is  set  to  NULL  and  *n is set 0 before the call, then
   getline() will allocate a buffer for storing  the  line.   This  buffer
   should be freed by the user program even if getline() failed.

   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
   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, getline() and getdelim() return the  number  of  characters
   read,   including  the  delimiter  character,  but  not  including  the
   terminating 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).

ATTRIBUTES

   For   an   explanation   of   the  terms  used  in  this  section,  see
   attributes(7).

   ┌──────────────────────┬───────────────┬─────────┐
   │InterfaceAttributeValue   │
   ├──────────────────────┼───────────────┼─────────┤
   │getline(), getdelim() │ Thread safety │ MT-Safe │
   └──────────────────────┴───────────────┴─────────┘

CONFORMING TO

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

EXAMPLE

   #define _GNU_SOURCE
   #include <stdio.h>
   #include <stdlib.h>

   int
   main(void)
   {
       FILE *stream;
       char *line = NULL;
       size_t len = 0;
       ssize_t read;

       stream = fopen("/etc/motd", "r");
       if (stream == NULL)
           exit(EXIT_FAILURE);

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

       free(line);
       fclose(stream);
       exit(EXIT_SUCCESS);
   }

SEE ALSO

   read(2), fgets(3), fopen(3), fread(3), scanf(3)

COLOPHON

   This  page  is  part of release 4.09 of the Linux man-pages project.  A
   description of the project, information about reporting bugs,  and  the
   latest     version     of     this    page,    can    be    found    at
   https://www.kernel.org/doc/man-pages/.





Opportunity


Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.





Free Software


Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.


Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.





Free Books


The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.


Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.





Education


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.


Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.