FUNOPEN

Section: C Library Functions (3)
Index Return to Main Contents

BSD mandoc

NAME

funopen fropen fwopen - open a stream

SYNOPSIS

Fd #include <stdio.h> Ft FILE * Fn funopen void *cookie int (*readfn)(void *, char *, int) int (writefn*)(void *, const char *, int) fpos_t (seekfn*)(void *, fpos_t, int) int (closefn*)(void *) Ft FILE * Fn fropen void *cookie int (*readfn)(void *, char *, int) Ft FILE * Fn fwopen void *cookie int (*writefn)(void *, char *, int)

DESCRIPTION

The Fn funopen function associates a stream with up to four ``I/O functions '' Either Fa readfn or Fa writefn must be specified; the others can be given as an appropriately-typed NULL pointer. These I/O functions will be used to read, write, seek and close the new stream.

In general, omitting a function means that any attempt to perform the associated operation on the resulting stream will fail. If the close function is omitted, closing the stream will flush any buffered output and then succeed.

The calling conventions of Fa readfn , Fa writefn , Fa seekfn and Fa closefn must match those, respectively, of read(2), write(2), seek(2), and close(2) with the single exception that they are passed the Fa cookie argument specified to Fn funopen in place of the traditional file descriptor argument.

Read and write I/O functions are allowed to change the underlying buffer on fully buffered or line buffered streams by calling setvbuf(3). They are also not required to completely fill or empty the buffer. They are not, however, allowed to change streams from unbuffered to buffered or to change the state of the line buffering flag. They must also be prepared to have read or write calls occur on buffers other than the one most recently specified.

All user I/O functions can report an error by returning -1. Additionally, all of the functions should set the external variable errno appropriately if an error occurs.

An error on Fn closefn does not keep the stream open.

As a convenience, the include file Aq Pa stdio.h defines the macros Fn fropen and Fn fwopen as calls to Fn funopen with only a read or write function specified.

RETURN VALUES

Upon successful completion, Fn funopen returns a FILE pointer. Otherwise, NULL is returned and the global variable errno is set to indicate the error.

ERRORS

Bq Er EINVAL: The Fn funopen function was called without either a read or write function. The Fn funopen function may also fail and set errno for any of the errors specified for the routine malloc(3).

HISTORY

The Fn funopen functions first appeared in 4.4BSD.

BUGS

The Fn funopen function may not be portable to systems other than BSD .

This document was created by man2html, using the manual pages.
Time: 15:52:51 GMT, January 15, 2023