xcb_sync_query_alarm - Man Page

Synopsis

#include <xcb/sync.h>

Request function

xcb_sync_query_alarm_cookie_t xcb_sync_query_alarm(xcb_connection_t *conn, xcb_sync_alarm_t alarm);

Reply datastructure

typedef struct xcb_sync_query_alarm_reply_t {
    uint8_t            response_type;
    uint8_t            pad0;
    uint16_t           sequence;
    uint32_t           length;
    xcb_sync_trigger_t trigger;
    xcb_sync_int64_t   delta;
    uint8_t            events;
    uint8_t            state;
    uint8_t            pad1[2];
} xcb_sync_query_alarm_reply_t;

Reply function

xcb_sync_query_alarm_reply_t *xcb_sync_query_alarm_reply(xcb_connection_t *conn, xcb_sync_query_alarm_cookie_t cookie, xcb_generic_error_t **e);

Request Arguments

conn

The XCB connection to X11.

alarm

TODO: NOT YET DOCUMENTED.

Reply Fields

response_type

The type of this reply, in this case XCB_SYNC_QUERY_ALARM. 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).

trigger

TODO: NOT YET DOCUMENTED.

delta

TODO: NOT YET DOCUMENTED.

events

TODO: NOT YET DOCUMENTED.

state

TODO: NOT YET DOCUMENTED.

Description

Return Value

Returns an xcb_sync_query_alarm_cookie_t. Errors have to be handled when calling the reply function xcb_sync_query_alarm_reply.

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

Errors

This request does never generate any errors.

See Also

Author

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

Referenced By

The man pages xcb_sync_query_alarm_reply(3) and xcb_sync_query_alarm_unchecked(3) are aliases of xcb_sync_query_alarm(3).

libxcb 1.17.0 X Version 11 XCB Requests