bgets(3gen) [opensolaris man page]

bgets(3GEN)					     String Pattern-Matching Library Functions					       bgets(3GEN)

NAME

       bgets - read stream up to next delimiter

SYNOPSIS

       cc [ flag ... ] file ... -lgen [ library ... ]
       #include <libgen.h>

       char *bgets(char *buffer, size_t count, FILE  *stream,
	    const char *breakstring);

DESCRIPTION

       The  bgets()  function  reads characters from stream into buffer until either count is exhausted or one of the characters in breakstring is
       encountered in the stream. The read data is terminated with a null byte ('') and a pointer to the trailing null is returned. If a  break-
       string character is encountered, the last non-null is the delimiter character that  terminated the scan.

       Note that, except for the fact that the returned value points to the end of the read string rather than to the beginning, the call

	 bgets(buffer, sizeof buffer, stream, "
");

       is identical to

	 fgets (buffer, sizeof buffer, stream);

       There is always enough room reserved in the buffer for the trailing null character.

       If  breakstring	is  a  null pointer, the value of breakstring from the previous call is used. If breakstring is null at the first call, no
       characters will be used to delimit the string.

RETURN VALUES

       NULL is returned on error or end-of-file.  Reporting the condition is delayed to the next  call if any characters were  read  but  not  yet
       returned.

EXAMPLES

       Example 1 Example of the bgets() function.

       The following example prints the name of the first user encountered in /etc/passswd, including a trailing ":"

	 #include <stdio.h>
	 #include<libgen.h>

	 int main()
	 {
	     char buffer[8];
	     FILE *fp;

	     if ((fp = fopen("/etc/passwd","r")) == NULL) {
		 perror("/etc/passwd");
		 return 1;
	     }
	     if (bgets(buffer, 8, fp, ":") == NULL) {
		 perror("bgets");
		 return 1;
	     }
	     (void) puts(buffer);
	     return 0;
	 }

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       gets(3C), attributes(5)

NOTES

       When  compiling multithread applications, the _REENTRANT flag must be defined on the compile line.  This flag should only be used in multi-
       threaded applications.

SunOS 5.11							    9 May 2001							       bgets(3GEN)

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

bgets(3gen) [opensolaris man page]

Check Out this Related Man Page