aboutsummaryrefslogtreecommitdiffstats
path: root/libaxl_detach.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2020-05-10 17:26:03 +0200
committerMattias Andrée <maandree@kth.se>2020-05-10 17:26:03 +0200
commit0e676861b71b8a17fdf0b968ef32751e2df30444 (patch)
treea2c1bb8dc26c0f0c3dda126cec45df5682fcf682 /libaxl_detach.3
parentA few things (diff)
downloadlibaxl-0e676861b71b8a17fdf0b968ef32751e2df30444.tar.gz
libaxl-0e676861b71b8a17fdf0b968ef32751e2df30444.tar.bz2
libaxl-0e676861b71b8a17fdf0b968ef32751e2df30444.tar.xz
Documentation + return -1 screen when not specified
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libaxl_detach.3')
-rw-r--r--libaxl_detach.335
1 files changed, 35 insertions, 0 deletions
diff --git a/libaxl_detach.3 b/libaxl_detach.3
new file mode 100644
index 0000000..8d1fb54
--- /dev/null
+++ b/libaxl_detach.3
@@ -0,0 +1,35 @@
+.TH libaxl_detach 3 libaxl
+.SH NAME
+libaxl_detach - Deallocate but do not close connection
+.SH SYNOPSIS
+.nf
+#include <libaxl.h>
+
+int libaxl_detach(LIBAXL_CONNECTION *\fIconn\fP);
+.fi
+.SH DESCRIPTION
+The
+.BR libaxl_detach ()
+function deallocates the connection record
+specified in the
+.I conn
+parameter, which the function will assume is
+.IR non- NULL ,
+but return the file descriptor of the connection
+instead of closing it.
+.SH RETURN VALUE
+The
+.BR libaxl_detach ()
+returns the file descriptor of the connection.
+.SH ERRORS
+The
+.BR libaxl_detach ()
+function cannot fail.
+.SH NOTES
+None.
+.SH SEE ALSO
+.BR libaxl_marshal (3),
+.BR libaxl_fileno (3),
+.BR libaxl_close (3),
+.BR libaxl_detach (3),
+.BR libaxl_attach (3)