From 4a968d807d2ec611f443d704ae875911894c04e2 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 10 May 2020 13:44:06 +0200 Subject: A few things MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- libaxl_deallocate_id.3 | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 libaxl_deallocate_id.3 (limited to 'libaxl_deallocate_id.3') diff --git a/libaxl_deallocate_id.3 b/libaxl_deallocate_id.3 new file mode 100644 index 0000000..f475bee --- /dev/null +++ b/libaxl_deallocate_id.3 @@ -0,0 +1,34 @@ +.TH libaxl_deallocate_id 3 libaxl +.SH NAME +libaxl_deallocate_id - Mark a resource ID as reusable +.SH SYNOPSIS +.nf +#include + +int libaxl_deallocate_id(LIBAXL_CONTEXT *\fIctx\fP, libaxl_id_t \fIid\fP); +.fi +.SH DESCRIPTION +The +.BR libaxl_deallocate_id () +function marks that the resource ID +specified in the +.I id +parameter is reusable. The value of the +.I ctx +parameter must be +.RI non- NULL +(the function will assume this to be +the case) and must be created for the +same connection as the ID was generated +for. +.SH RETURN VALUE +The +.BR libaxl_deallocate_id () +function returns 0 on successful completion +and a negative libaxl error code on failure. +.SH ERRORS +TODO \" errors for libaxl_deallocate_id +.SH NOTES +None. +.SH SEE ALSO +.BR libaxl_generate_id (3) -- cgit v1.2.3-70-g09d2