libowfat/io/iob_addfile.3

20 lines
641 B
Groff
Raw Normal View History

2004-03-02 20:02:23 +00:00
.TH iob_addfile 3
.SH NAME
iob_addfile \- add file region to I/O batch
.SH SYNTAX
.B #include <libowfat/iob.h>
2004-03-02 20:02:23 +00:00
2012-01-13 02:25:31 +00:00
int \fBiob_addfile\fP(io_batch* b,int64 fd,uint64 off,uint64 n);
2004-03-02 20:02:23 +00:00
.SH DESCRIPTION
iob_addfile schedules \fIn\fR bytes from the file descriptor \fIfd\fR
starting at offset \fIoff\fR to be written with the I/O batch \fIb\fR.
You may not close \fIfd\fR before iob_send indicates it is done.
Use \fBiob_addfile_close\fR if you want the file descriptor to be closed
automatically by \fBiob_reset\fR.
2012-01-13 02:25:31 +00:00
.SH "RETURN VALUE"
Returns 1 on success, 0 on failure.
2004-03-02 20:02:23 +00:00
.SH "SEE ALSO"
iob_reset(3), iob_send(3), iob_addbuf(3), iob_addfile_close(3)