1XAddHost(3) XLIB FUNCTIONS XAddHost(3)
2
6 XAddHost, XAddHosts, XListHosts, XRemoveHost, XRemoveHosts, XSetAccess‐
7 Control, XEnableAccessControl, XDisableAccessControl, XHostAddress,
8 XServerInterpretedAddress - control host access and host control struc‐
9 ture
10
12 int XAddHost(Display *display, XHostAddress *host);
13 int XAddHosts(Display *display, XHostAddress *hosts, int num_hosts);
15 XHostAddress *XListHosts(Display *display, int *nhosts_return, Bool
17 *state_return);
18 int XRemoveHost(Display *display, XHostAddress *host);
20 int XRemoveHosts(Display *display, XHostAddress *hosts, int num_hosts);
22 int XSetAccessControl(Display *display, int mode);
24 int XEnableAccessControl(Display *display);
26 int XDisableAccessControl(Display *display);
28
30 display Specifies the connection to the X server.
31 host Specifies the host that is to be added or removed.
33 hosts Specifies each host that is to be added or removed.
35 mode Specifies the mode. You can pass EnableAccess or DisableAc‐
37 cess.
38 nhosts_return
40 Returns the number of hosts currently in the access control
41 list.
42 num_hosts Specifies the number of hosts.
44 state_return
46 Returns the state of the access control.
47
49 The XAddHost function adds the specified host to the access control
50 list for that display. The server must be on the same host as the
51 client issuing the command, or a BadAccess error results.
52 XAddHost can generate BadAccess and BadValue errors.
54 The XAddHosts function adds each specified host to the access control
56 list for that display. The server must be on the same host as the
57 client issuing the command, or a BadAccess error results.
58 XAddHosts can generate BadAccess and BadValue errors.
60 The XListHosts function returns the current access control list as well
62 as whether the use of the list at connection setup was enabled or dis‐
63 abled. XListHosts allows a program to find out what machines can make
64 connections. It also returns a pointer to a list of host structures
65 that were allocated by the function. When no longer needed, this mem‐
66 ory should be freed by calling XFree.
67 The XRemoveHost function removes the specified host from the access
69 control list for that display. The server must be on the same host as
70 the client process, or a BadAccess error results. If you remove your
71 machine from the access list, you can no longer connect to that server,
72 and this operation cannot be reversed unless you reset the server.
73 XRemoveHost can generate BadAccess and BadValue errors.
75 The XRemoveHosts function removes each specified host from the access
77 control list for that display. The X server must be on the same host
78 as the client process, or a BadAccess error results. If you remove
79 your machine from the access list, you can no longer connect to that
80 server, and this operation cannot be reversed unless you reset the
81 server.
82 XRemoveHosts can generate BadAccess and BadValue errors.
84 The XSetAccessControl function either enables or disables the use of
86 the access control list at each connection setup.
87 XSetAccessControl can generate BadAccess and BadValue errors.
89 The XEnableAccessControl function enables the use of the access control
91 list at each connection setup.
92 XEnableAccessControl can generate a BadAccess error.
94 The XDisableAccessControl function disables the use of the access con‐
96 trol list at each connection setup.
97 XDisableAccessControl can generate a BadAccess error.
99
101 The XHostAddress structure contains:
102 typedef struct {
104 int family; /* for example FamilyInternet */
105 int length; /* length of address, in bytes */
106 char *address; /* pointer to where to find the address */
107 } XHostAddress;
108 The family member specifies which protocol address family to use (for
110 example, TCP/IP or DECnet) and can be FamilyInternet, FamilyInternet6,
111 FamilyServerInterpreted, FamilyDECnet, or FamilyChaos. The length mem‐
112 ber specifies the length of the address in bytes. The address member
113 specifies a pointer to the address.
114 For the ServerInterpreted family, the length is ignored and the address
116 member is a pointer to a XServerInterpretedAddress structure which con‐
117 tains:
118 typedef struct {
120 int typelength; /* length of type string, in bytes */
121 int valuelength; /* length of value string, in bytes */
122 char *type; /* pointer to where to find the type string */
123 char *value; /* pointer to where to find the address */
124 } XServerInterpretedAddress;
125 The type and value members point to strings representing the type and
127 value of the server interpreted entry. These strings may not be NULL-
128 terminated so care should be used when accessing them. The typelength
129 and valuelength members specify the length in byte of the type and
130 value strings.
131
133 BadAccess A client attempted to modify the access control list from
134 other than the local (or otherwise authorized) host.
135 BadValue Some numeric value falls outside the range of values accepted
137 by the request. Unless a specific range is specified for an
138 argument, the full range defined by the argument's type is
139 accepted. Any argument defined as a set of alternatives can
140 generate this error.
141
143 XFree(3)
144 Xlib - C Language X Interface
145X Version 11 libX11 1.7.3.1 XAddHost(3)