NAME

getdelim, getline – read a delimited record from stream

SYNOPSIS

#include <stdio.h>

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

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

DESCRIPTION

The getdelim() function reads from stream until it encounters a character matching the delimiter character.

The application shall ensure that *lineptr is a valid argument that could be passed to the free() function. If *n is non-zero, the application shall ensure that *lineptr either points to an object of size at least *n bytes, or is a null pointer.

The size of the object pointed to by *lineptr will be increased to fit the incoming line, if it isn’t already large enough, including room for the delimiter and a terminating NUL. The characters read, including any delimiter, will be stored in the string pointed to by the lineptr argument, and a terminating NUL added when the delimiter or end of file is encountered.

The getline() function shall be equivalent to the getdelim() function with the delimiter character equal to the <newline> character ‘\n’.

RETURN VALUES

On success, getline() and getdelim() return the number of characters read, including the delimiter character, but not including the terminating null character. The value -1 is returned if an error occurs, or if end-of-file is reached.

ERRORS

These functions are members of Unison’s STDIO implementation. The STDIO implementation rests on top of IOLIB and inherits IOLIB’s dependency on each specific server to report an appropriate error code for its usage.

For an exact list of error codes returned by a particular server, refer to that server’s documentation in the Unison Programmer’s Guide for each specific platform.

Servers may implement these errors codes in response to this function.

For the conditions under which the getdelim() and getline() functions fail refer to fgetc() .

In addition, these functions fail if:

[EINVAL]

lineptr or n is a null pointer.

[ENOMEM]

Insufficient memory is available.

SEE ALSO

getc(), fgetc(), gets(), fgets(), ungetc()