MirBSD manpage: XRes(3), XResQueryClientPixmapBytes(3), XResQueryClientResources(3), XResQueryClients(3), XResQueryExtension(3), XResQueryVersion(3)


XRes(3)             UNIX Programmer's Manual              XRes(3)

NAME

     XRes - X-Resource extension client library

SYNOPSIS

     #include <X11/extension/XRes.h>

     typedef struct {
          XID            resource_base;
          XID            resource_mask;
     } XResClient;

     typedef struct {
          Atom           resource_type;
          unsigned int   count;
     } XResType;

     Bool XResQueryExtension(Display *dpy, int *event_basep, int
          *error_basep);

     Status XResQueryVersion(Display *dpy, int *major_versionp,
          int *minor_versionp);

     Status XResQueryClients(Display *dpy, int *num_clients,
          XResClient **clients);

     Status XResQueryClientResources(Display *dpy, XID xid, int
          *num_types, XResType **types);

     Status XResQueryClientPixmapBytes(Display *dpy, XID xid,
          unsigned long *bytes);

DESCRIPTION

     X-Resource is an extension that allows a client to query the
     X server about its usage of various resources. It should not
     be mixed with the X resource database access functions.

     XResQueryExtension returns True if the XRes extension is
     available on the given display. A client must call
     XResQueryExtension before calling any other XRes function in
     order to negotiate a compatible protocol version; otherwise
     the client will get undefined behavior (XRes may or may not
     work).

     XResQueryVersion returns True if the request succeeded; the
     values of the major and minor protocol versions supported by
     the server are returned in major_versionp and minor_versionp
     .

     XResQueryClients fills a list of clients of the given
     display. For each client it returns in the XResClient struc-
     ture a mask and a base value of the resources used by these
     clients. Returns True on success or False on failure.

XFree86                   Version 4.5.0                         1

XRes(3)             UNIX Programmer's Manual              XRes(3)

     XResQueryClientResources fills a list of XResType struc-
     tures, indicating for each resource type allocated by the
     client its name (as an Atom) and the number of resources of
     this type allocated. Returns True on success or False on
     failure.

     XresQueryClientPixmapBytes gives, for resources of type PIX-
     MAP the total number of bytes allocated in the X server by
     the given client. Returns True on success or False on
     failure.

ERRORS

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

SEE ALSO

     Xlib(1), X(7)

AUTHOR

     Mark Vojkovich, for The XFree86 Project Inc.

STABILITY

     This API is considered as experimental. The XRes library
     major revision may be incremented whenever incompatible
     changes are done to the API without notice. Use with care.

XFree86                   Version 4.5.0                         2

Generated on 2021-12-07 11:07:08 by $MirOS: src/scripts/roff2htm,v 1.103 2021/01/23 20:24:35 tg Exp $ — This product includes material provided by mirabilos.

These manual pages and other documentation are copyrighted by their respective writers; their sources are available at the project’s CVSweb, AnonCVS and other mirrors. The rest is Copyright © 2002–2021 MirBSD.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.