From e73c3e85f18e3a0ee95fb431e579abe589435b46 Mon Sep 17 00:00:00 2001 From: leitner Date: Tue, 8 Mar 2005 13:54:36 +0000 Subject: [PATCH] document error case --- io/iob_new.3 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/io/iob_new.3 b/io/iob_new.3 index 8c7067a..be44a84 100644 --- a/io/iob_new.3 +++ b/io/iob_new.3 @@ -18,5 +18,8 @@ APIs like FreeBSD's sendfile. The file contents will always be sent in a way that allows the operating systems to perform zero copy TCP, and the buffers will always be sent using as few syscalls as possible and avoiding unnecessary copying (using writev). +.SH "RETURN VALUE" +iob_new returns a pointer to an I/O batch data structure. If there was +a memory allocation error, it returns NULL instead. .SH "SEE ALSO" iob_reset(3), iob_send(3), iob_addbuf(3), iob_adds_free(3), iob_addfile(3)