aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libaxl_context_create.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2020-06-21 12:09:51 +0200
committerMattias Andrée <maandree@kth.se>2020-06-21 12:09:51 +0200
commit0007c3f8d17fb4b397d6d4e42b10f2ceee5b0d6a (patch)
tree73cc9f3704a934d05e8086fad9e6d906b7871131 /man3/libaxl_context_create.3
parentImplement & format token in libaxl_receive (diff)
downloadlibaxl-0007c3f8d17fb4b397d6d4e42b10f2ceee5b0d6a.tar.gz
libaxl-0007c3f8d17fb4b397d6d4e42b10f2ceee5b0d6a.tar.bz2
libaxl-0007c3f8d17fb4b397d6d4e42b10f2ceee5b0d6a.tar.xz
Move man pages into a separate directory
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man3/libaxl_context_create.3')
-rw-r--r--man3/libaxl_context_create.340
1 files changed, 40 insertions, 0 deletions
diff --git a/man3/libaxl_context_create.3 b/man3/libaxl_context_create.3
new file mode 100644
index 0000000..f764dca
--- /dev/null
+++ b/man3/libaxl_context_create.3
@@ -0,0 +1,40 @@
+.TH libaxl_context_create 3 libaxl
+.SH NAME
+libaxl_context_create - Create a context
+.SH SYNOPSIS
+.nf
+#include <libaxl.h>
+
+LIBAXL_CONTEXT *libaxl_context_create(LIBAXL_CONNECTION *\fIconn\fP);
+.fi
+.SH DESCRIPTION
+The
+.BR libaxl_context_create ()
+function creates a context, for a thread,
+to use when accessing the display server
+via the connection specified in the
+.I conn
+parameter.
+.SH RETURN VALUE
+The
+.BR libaxl_context_create ()
+function returns the context on success
+completion, or
+.I NULL
+on failure.
+.SH ERRORS
+The
+.BR libaxl_context_create ()
+function can only fail if enough memory
+cannot be allocates for the process,
+which is corresponds to the
+.I ENOMEM
+error number and the
+.I LIBAXL_ERROR_SYSTEM
+libaxl error number.
+.SH NOTES
+None.
+.SH SEE ALSO
+.BR libaxl_context_free (3),
+.BR libaxl_connect (3),
+.BR libaxl_create (3)