1XRes(3)                    Library Functions Manual                    XRes(3)
2
3
4

NAME

6       XRes - X-Resource extension client library
7

SYNOPSIS

9       #include <X11/extensions/XRes.h>
10
11       typedef struct {
12            XID            resource_base;
13            XID            resource_mask;
14       } XResClient;
15
16       typedef struct {
17            Atom           resource_type;
18            unsigned int   count;
19       } XResType;
20
21       Bool    XResQueryExtension(Display    *dpy,   int   *event_basep,   int
22              *error_basep);
23
24       Status  XResQueryVersion(Display   *dpy,   int   *major_versionp,   int
25              *minor_versionp);
26
27       Status  XResQueryClients(Display  *dpy,  int  *num_clients,  XResClient
28              **clients);
29
30       Status XResQueryClientResources(Display *dpy, XID xid, int  *num_types,
31              XResType **types);
32
33       Status  XResQueryClientPixmapBytes(Display *dpy, XID xid, unsigned long
34              *bytes);
35

DESCRIPTION

37       X-Resource is an extension that allows a client to query the  X  server
38       about its usage of various resources. It should not be mixed with the X
39       resource database access functions.
40
41       XResQueryExtension returns True if the XRes extension is  available  on
42       the  given display.  A client must call XResQueryExtension before call‐
43       ing any other XRes function in order to negotiate a compatible protocol
44       version;  otherwise the client will get undefined behavior (XRes may or
45       may not work).
46
47       XResQueryVersion returns True if the request succeeded; the  values  of
48       the  major  and  minor  protocol  versions  supported by the server are
49       returned in major_versionp and minor_versionp .
50
51       XResQueryClients fills a list of clients of the given display. For each
52       client  it  returns in the XResClient structure a mask and a base value
53       of the resources used by these clients.  Returns  True  on  success  or
54       False on failure.
55
56       XResQueryClientResources  fills a list of XResType structures, indicat‐
57       ing for each resource type allocated by the  client  its  name  (as  an
58       Atom) and the number of resources of this type allocated.  Returns True
59       on success or False on failure.
60
61       XresQueryClientPixmapBytes gives, for  resources  of  type  PIXMAP  the
62       total  number  of  bytes allocated in the X server by the given client.
63       Returns True on success or False on failure.
64

ERRORS

66       XResQueryClientResources  and  XResQueryClientPixmapBytes  will  return
67       BadValue if passed an illegal client identifier.
68

SEE ALSO

70       X(7)
71

AUTHOR

73       Mark Vojkovich, originally for The XFree86 Project Inc.
74

STABILITY

76       This API is considered as experimental. The XRes library major revision
77       may be incremented whenever incompatible changes are done  to  the  API
78       without notice. Use with care.
79
80
81
82X Version 11                     libXres 1.0.2                         XRes(3)