xcb_get_screen_saver man page

xcb_get_screen_saver —

Synopsis

#include <xcb/xproto.h>

Request function

xcb_get_screen_saver_cookie_t xcb_get_screen_saver(xcb_connection_t *conn,

Reply datastructure

typedef struct xcb_get_screen_saver_reply_t {
    uint8_t  response_type;
    uint8_t  pad0;
    uint16_t sequence;
    uint32_t length;
    uint16_t timeout;
    uint16_t interval;
    uint8_t  prefer_blanking;
    uint8_t  allow_exposures;
    uint8_t  pad1[18];
} xcb_get_screen_saver_reply_t;

Reply function

xcb_get_screen_saver_reply_t *xcb_get_screen_saver_reply(xcb_connection_t *conn, xcb_get_screen_saver_cookie_t cookie, xcb_generic_error_t **e);

Request Arguments

conn
The XCB connection to X11.

Reply Fields

response_type
The type of this reply, in this case XCB_GET_SCREEN_SAVER. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other.
sequence
The sequence number of the last request processed by the X11 server.
length
The length of the reply, in words (a word is 4 bytes).
timeout
TODO: NOT YET DOCUMENTED.
interval
TODO: NOT YET DOCUMENTED.
prefer_blanking

One of the following values:

XCB_BLANKING_NOT_PREFERRED
TODO: NOT YET DOCUMENTED.
XCB_BLANKING_PREFERRED
TODO: NOT YET DOCUMENTED.
XCB_BLANKING_DEFAULT
TODO: NOT YET DOCUMENTED.

TODO: NOT YET DOCUMENTED.

allow_exposures

One of the following values:

XCB_EXPOSURES_NOT_ALLOWED
TODO: NOT YET DOCUMENTED.
XCB_EXPOSURES_ALLOWED
TODO: NOT YET DOCUMENTED.
XCB_EXPOSURES_DEFAULT
TODO: NOT YET DOCUMENTED.

TODO: NOT YET DOCUMENTED.

Return Value

Returns an xcb_get_screen_saver_cookie_t. Errors have to be handled when calling the reply function xcb_get_screen_saver_reply.

If you want to handle errors in the event loop instead, use xcb_get_screen_saver_unchecked. See xcb-requests(3) for details.

Errors

This request does never generate any errors.

Author

Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.

Referenced By

xcb_get_screen_saver_reply(3) and xcb_get_screen_saver_unchecked(3) are aliases of xcb_get_screen_saver(3).

libxcb 1.12 X Version 11 XCB Requests