getdelim(3) [freebsd man page]

GETLINE(3)						   BSD Library Functions Manual 						GETLINE(3)

NAME

     getdelim, getline -- get a line from a stream

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #define _WITH_GETLINE
     #include <stdio.h>

     ssize_t
     getdelim(char ** restrict linep, size_t * restrict linecapp, int delimiter, FILE * restrict stream);

     ssize_t
     getline(char ** restrict linep, size_t * restrict linecapp, FILE * restrict stream);

DESCRIPTION

     The getdelim() function reads a line from stream, delimited by the character delimiter.  The getline() function is equivalent to getdelim()
     with the newline character as the delimiter.  The delimiter character is included as part of the line, unless the end of the file is reached.

     The caller may provide a pointer to a malloced buffer for the line in *linep, and the capacity of that buffer in *linecapp.  These functions
     expand the buffer as needed, as if via realloc().	If linep points to a NULL pointer, a new buffer will be allocated.  In either case, *linep
     and *linecapp will be updated accordingly.

RETURN VALUES

     The getdelim() and getline() functions return the number of characters stored in the buffer, excluding the terminating NUL character.  The
     value -1 is returned if an error occurs, or if end-of-file is reached.

EXAMPLES

     The following code fragment reads lines from a file and writes them to standard output.  The fwrite() function is used in case the line con-
     tains embedded NUL characters.

	   char *line = NULL;
	   size_t linecap = 0;
	   ssize_t linelen;
	   while ((linelen = getline(&line, &linecap, fp)) > 0)
		   fwrite(line, linelen, 1, stdout);
	   free(line);

COMPATIBILITY

     Many application writers used the name getline before the getline() function was introduced in IEEE Std 1003.1 (``POSIX.1''), so a prototype
     is not provided by default in order to avoid compatibility problems.  Applications that wish to use the getline() function described herein
     should either request a strict IEEE Std 1003.1-2008 (``POSIX.1'') environment by defining the macro _POSIX_C_SOURCE to the value 200809 or
     greater, or by defining the macro _WITH_GETLINE, prior to the inclusion of <stdio.h>.  For compatibility with GNU libc, defining either
     _BSD_SOURCE or _GNU_SOURCE prior to the inclusion of <stdio.h> will also make getline() available.

ERRORS

     These functions may fail if:

     [EINVAL]		Either linep or linecapp is NULL.

     [EOVERFLOW]	No delimiter was found in the first SSIZE_MAX characters.

     These functions may also fail due to any of the errors specified for fgets() and malloc().

SEE ALSO

     fgetln(3), fgets(3), malloc(3)

STANDARDS

     The getdelim() and getline() functions conform to IEEE Std 1003.1-2008 (``POSIX.1'').

HISTORY

     These routines first appeared in FreeBSD 8.0.

BUGS

     There are no wide character versions of getdelim() or getline().

BSD
								 November 30, 2012							       BSD

Check Out this Related Man Page

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

NAME

       getline, getdelim - delimited string input

SYNOPSIS

       #define _GNU_SOURCE
       #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);

DESCRIPTION

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

       If *lineptr is NULL, the getline() routine will allocate a buffer for containing the line, which must be freed by the user program.  Alter-
       natively,  before  calling  getline(), *lineptr can contain a pointer to a malloc()-allocated buffer *n bytes in size. If the buffer is not
       large enough to hold the line read in, getline() resizes the buffer to fit with realloc(), 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 size respectively.

       getdelim()  works like getline(), except 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  termi-
       nating null character. This value can be used to handle embedded null characters 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).

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 :
", read);
		 printf("%s", line);
	    }
	    if (line)
		 free(line);
	    return EXIT_SUCCESS;
       }

CONFORMING TO

       Both getline() and getdelim() are GNU extensions.  They are available since libc 4.6.27.

SEE ALSO

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

GNU
								    2001-10-07								GETLINE(3)

Linux and UNIX Man Pages

getdelim(3) [freebsd man page]

Check Out this Related Man Page