From 8f8fb5ef585236f968797ca4c71664199ae42e0e Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Mon, 5 Nov 2018 22:12:03 +0100 Subject: Add man page for libsimple_close MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man/libsimple_close.3 | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 man/libsimple_close.3 (limited to 'man') diff --git a/man/libsimple_close.3 b/man/libsimple_close.3 new file mode 100644 index 0000000..d5e18c6 --- /dev/null +++ b/man/libsimple_close.3 @@ -0,0 +1,49 @@ +.TH LIBSIMPLE_CLOSE 3 2018-11-05 libsimple +.SH NAME +libsimple_close \- close file descriptor and mark it as closed +.SH SYNOPSIS +.nf +#include + +static inline int libsimple_close(int *\fIfdp\fP); +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_close () +function calls +.I close(*fdp) +and sets +.I *fdp +to +.IR \-1 . +However if +.IR *fdp<0 , +does not except return 0. +.SH RETURN VALUE +The +.BR libsimple_close () +function returns 0 upon successful completion; +otherwise \-1 is returned. +.SH ERRORS +The +.BR libsimple_close () +function fail for the reasons specified for the +.BR close (3) +function. +.SH EXAMPLES +None. +.SH APPLICATION USAGE +None. +.SH RATIONALE +None. +.SH FUTURE DIRECTIONS +None. +.SH NOTES +None. +.SH BUGS +None. +.SH SEE ALSO +.BR close (3) -- cgit v1.2.3-70-g09d2