2 .\" Copyright (C) 1994-2003 The XFree86 Project, Inc. All Rights Reserved.
4 .\" Permission is hereby granted, free of charge, to any person obtaining
5 .\" a copy of this software and associated documentation files (the
6 .\" "Software"), to deal in the Software without restriction, including
7 .\" without limitation the rights to use, copy, modify, merge, publish,
8 .\" distribute, sublicense, and/or sell copies of the Software, and to
9 .\" permit persons to whom the Software is furnished to do so, subject to
10 .\" the following conditions:
12 .\" The above copyright notice and this permission notice shall be
13 .\" included in all copies or substantial portions of the Software.
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
18 .\" IN NO EVENT SHALL THE XFREE86 PROJECT BE LIABLE FOR ANY CLAIM, DAMAGES
19 .\" OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 .\" Except as contained in this notice, the name of the XFree86 Project
24 .\" shall not be used in advertising or otherwise to promote the sale, use
25 .\" or other dealings in this Software without prior written authorization
26 .\" from the XFree86 Project.
28 .TH XRes __libmansuffix__ __vendorversion__
30 XRes \- X-Resource extension client library
32 .B #include <X11/extensions/XRes.h>
47 Bool XResQueryExtension(Display *\fIdpy\fP,
48 int *\fIevent_base_return\fP, int *\fIerror_base_return\fP\^);
50 Status XResQueryVersion(Display *\fIdpy\fP, int *\fImajor_version_return\fP,
51 int *\fIminor_version_return\fP\^);
53 Status XResQueryClients(Display *\fIdpy\fP, int *\fInum_clients\fP,
54 XResClient **\fIclients\fP\^);
56 Status XResQueryClientResources(Display *\fIdpy\fP, XID \fIxid\fP,
57 int *\fInum_types\fP, XResType **\fItypes\fP\^);
59 Status XResQueryClientPixmapBytes(Display *\fIdpy\fP, XID \fIxid\fP,
60 unsigned long *\fIbytes\fP\^);
64 is an extension that allows a client to query the X
65 server about its usage of various resources. It should not be confused
66 with the X resource database access functions.
73 extension is available on the given display.
76 before calling any other XRes function in order
77 to negotiate a compatible protocol version; otherwise the client will
78 get undefined behavior (XRes may or may not work).
83 if the request succeeded; the values of the major and minor protocol
84 versions supported by the server are returned in
85 .I major_version_return
87 .I minor_version_return .
91 fills a list of clients of the given display. For each client it
94 structure a mask and a base value of the resources used by these
102 .B XResQueryClientResources
105 structures, indicating for each resource type allocated by the client its
106 name (as an Atom) and the number of resources of this type allocated.
113 .B XResQueryClientPixmapBytes
114 gives, for resources of type
116 the total number of bytes allocated in the X server by the given
124 .B XResQueryClientResources
126 .B XResQueryClientPixmapBytes
129 if passed an illegal client identifier.
133 Mark Vojkovich, originally for The XFree86 Project Inc.
135 This API is considered as experimental. The XRes library major
136 revision may be incremented whenever incompatible changes are done to
137 the API without notice. Use with care.