xcb_screensaver_query_info man page

xcb_screensaver_query_info —

Synopsis

#include <xcb/screensaver.h>

Request function

xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info(xcb_connection_t *conn, xcb_drawable_t drawable);

Reply datastructure

typedef struct xcb_screensaver_query_info_reply_t {
    uint8_t      response_type;
    uint8_t      state;
    uint16_t     sequence;
    uint32_t     length;
    xcb_window_t saver_window;
    uint32_t     ms_until_server;
    uint32_t     ms_since_user_input;
    uint32_t     event_mask;
    uint8_t      kind;
    uint8_t      pad0[7];
} xcb_screensaver_query_info_reply_t;

Reply function

xcb_screensaver_query_info_reply_t *xcb_screensaver_query_info_reply(xcb_connection_t *conn, xcb_screensaver_query_info_cookie_t cookie, xcb_generic_error_t **e);

Request Arguments

conn
The XCB connection to X11.
drawable
TODO: NOT YET DOCUMENTED.

Reply Fields

response_type
The type of this reply, in this case XCB_SCREENSAVER_QUERY_INFO. 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).
state
TODO: NOT YET DOCUMENTED.
saver_window
TODO: NOT YET DOCUMENTED.
ms_until_server
TODO: NOT YET DOCUMENTED.
ms_since_user_input
TODO: NOT YET DOCUMENTED.
event_mask
TODO: NOT YET DOCUMENTED.
kind
TODO: NOT YET DOCUMENTED.

Return Value

Returns an xcb_screensaver_query_info_cookie_t. Errors have to be handled when calling the reply function xcb_screensaver_query_info_reply.

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

Errors

This request does never generate any errors.

Author

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

Referenced By

xcb_screensaver_query_info_reply(3) and xcb_screensaver_query_info_unchecked(3) are aliases of xcb_screensaver_query_info(3).

libxcb 1.12 X Version 11 XCB Requests