aboutsummaryrefslogtreecommitdiffstats
path: root/libaxl_create.3
blob: d29c32e6b1ce6ee657c70bb7f2a7a54bc216fe96 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
.TH libaxl_create 3 libaxl
.SH NAME
libaxl_create - Create connection record
.SH SYNOPSIS
.nf
#include <libaxl.h>

LIBAXL_CONNECTION *libaxl_create(int \fIfd\fP);
.fi
.SH DESCRIPTION
The
.BR libaxl_create ()
function creates a connection record context,
for a connection to the display server. The
connection does not have to be established
yet, but they socket for the connection should
have been created and should be specified in the
.I fd
parameter.
.SH RETURN VALUE
The
.BR libaxl_create ()
function returns the connection record on
success completion, or
.I NULL
on failure.
.SH ERRORS
The
.BR libaxl_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_connect (3),
.BR libaxl_parse_display (3),
.BR libaxl_send_handshake (3),
.BR libaxl_close (3),
.BR libaxl_detach (3),
.BR libaxl_attach (3),
.BR libaxl_context_create (3)