xcb_input_xi_get_property man page

xcb_input_xi_get_property —

Synopsis

#include <xcb/xinput.h>

Request function

xcb_input_xi_get_property_cookie_t xcb_input_xi_get_property(xcb_connection_t *conn, xcb_input_device_id_t deviceid, uint8_t _delete, xcb_atom_t property, xcb_atom_t type, uint32_t offset, uint32_t len);

Reply datastructure

typedef struct xcb_input_xi_get_property_reply_t {
    uint8_t    response_type;
    uint8_t    pad0;
    uint16_t   sequence;
    uint32_t   length;
    xcb_atom_t type;
    uint32_t   bytes_after;
    uint32_t   num_items;
    uint8_t    format;
    uint8_t    pad1[11];
} xcb_input_xi_get_property_reply_t;

Reply function

xcb_input_xi_get_property_reply_t *xcb_input_xi_get_property_reply(xcb_connection_t *conn, xcb_input_xi_get_property_cookie_t cookie, xcb_generic_error_t **e);

Reply accessors

xcb_input_xi_get_property_items_t *xcb_input_xi_get_property_items (const xcb_input_xi_get_property_request_t *reply)

Request Arguments

conn
The XCB connection to X11.
deviceid
TODO: NOT YET DOCUMENTED.
_delete
TODO: NOT YET DOCUMENTED.
property
TODO: NOT YET DOCUMENTED.
type
TODO: NOT YET DOCUMENTED.
offset
TODO: NOT YET DOCUMENTED.
len
TODO: NOT YET DOCUMENTED.

Reply Fields

response_type
The type of this reply, in this case XCB_INPUT_XI_GET_PROPERTY. 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).
type
TODO: NOT YET DOCUMENTED.
bytes_after
TODO: NOT YET DOCUMENTED.
num_items
TODO: NOT YET DOCUMENTED.
format
TODO: NOT YET DOCUMENTED.

Return Value

Returns an xcb_input_xi_get_property_cookie_t. Errors have to be handled when calling the reply function xcb_input_xi_get_property_reply.

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

Errors

This request does never generate any errors.

Author

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

Referenced By

xcb_input_xi_get_property_items(3), xcb_input_xi_get_property_reply(3) and xcb_input_xi_get_property_unchecked(3) are aliases of xcb_input_xi_get_property(3).

libxcb 1.12 X Version 11 XCB Requests