xcb_xkb_get_compat_map_si_rtrn_iterator (3) - Linux Manuals

Command to display xcb_xkb_get_compat_map_si_rtrn_iterator manual in Linux: $ man 3 xcb_xkb_get_compat_map_si_rtrn_iterator

NAME

xcb_xkb_get_compat_map -

SYNOPSIS

#include <xcb/xkb.h>

Request function

: xcb_xkb_get_compat_map_cookie_t xcb_xkb_get_compat_map(xcb_connection_t *conn, xcb_xkb_device_spec_t deviceSpec, uint8_t groups, uint8_t getAllSI, uint16_t firstSI, uint16_t nSI);

Reply datastructure

typedef struct xcb_xkb_get_compat_map_reply_t {
    uint8_t  response_type;
    uint8_t  deviceID;
    uint16_t sequence;
    uint32_t length;
    uint8_t  groupsRtrn;
    uint8_t  pad0;
    uint16_t firstSIRtrn;
    uint16_t nSIRtrn;
    uint16_t nTotalSI;
    uint8_t  pad1[16];
} xcb_xkb_get_compat_map_reply_t;

Reply function

: xcb_xkb_get_compat_map_reply_t *xcb_xkb_get_compat_map_reply(xcb_connection_t *conn, xcb_xkb_get_compat_map_cookie_t cookie, xcb_generic_error_t **e);

Reply accessors

: xcb_xkb_sym_interpret_t *xcb_xkb_get_compat_map_si_rtrn(const xcb_xkb_get_compat_map_request_t *reply);
: int xcb_xkb_get_compat_map_si_rtrn_length(const xcb_xkb_get_compat_map_reply_t *reply);
: xcb_xkb_sym_interpret_iterator_t xcb_xkb_get_compat_map_si_rtrn_iterator(const xcb_xkb_get_compat_map_reply_t *reply);
: xcb_xkb_mod_def_t *xcb_xkb_get_compat_map_group_rtrn(const xcb_xkb_get_compat_map_request_t *reply);
: int xcb_xkb_get_compat_map_group_rtrn_length(const xcb_xkb_get_compat_map_reply_t *reply);
: xcb_xkb_mod_def_iterator_t xcb_xkb_get_compat_map_group_rtrn_iterator(const xcb_xkb_get_compat_map_reply_t *reply);

REQUEST ARGUMENTS

conn: The XCB connection to X11.
deviceSpec: TODO: NOT YET DOCUMENTED.
groups: TODO: NOT YET DOCUMENTED.
getAllSI: TODO: NOT YET DOCUMENTED.
firstSI: TODO: NOT YET DOCUMENTED.
nSI: TODO: NOT YET DOCUMENTED.

REPLY FIELDS

response_type: The type of this reply, in this case XCB_XKB_GET_COMPAT_MAP. 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).
deviceID: TODO: NOT YET DOCUMENTED.
groupsRtrn: TODO: NOT YET DOCUMENTED.
firstSIRtrn: TODO: NOT YET DOCUMENTED.
nSIRtrn: TODO: NOT YET DOCUMENTED.
nTotalSI: TODO: NOT YET DOCUMENTED.

DESCRIPTION

RETURN VALUE

Returns an xcb_xkb_get_compat_map_cookie_t. Errors have to be handled when calling the reply function xcb_xkb_get_compat_map_reply.

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

ERRORS

This request does never generate any errors.

AUTHOR

Generated from xkb.xml. Contact xcb [at] lists.freedesktop.org for corrections and improvements.