---
name: "xcb_xkb_get_state"
section: "3"
platform: "linux"
package: "libxcb"
version: "1.17.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/xcb_xkb_get_state"
---

# xcb\_xkb\_get\_state(3)

## NAME

xcb\_xkb\_get\_state -

## SYNOPSIS

**#include \<xcb/xkb.h\>**

### Request function

xcb\_xkb\_get\_state\_cookie\_t **xcb\_xkb\_get\_state**(xcb\_connection\_t \**conn*, xcb\_xkb\_device\_spec\_t *deviceSpec*);

### Reply datastructure

```

typedef struct xcb_xkb_get_state_reply_t {
    uint8_t  response_type;
    uint8_t  deviceID;
    uint16_t sequence;
    uint32_t length;
    uint8_t  mods;
    uint8_t  baseMods;
    uint8_t  latchedMods;
    uint8_t  lockedMods;
    uint8_t  group;
    uint8_t  lockedGroup;
    int16_t  baseGroup;
    int16_t  latchedGroup;
    uint8_t  compatState;
    uint8_t  grabMods;
    uint8_t  compatGrabMods;
    uint8_t  lookupMods;
    uint8_t  compatLookupMods;
    uint8_t  pad0;
    uint16_t ptrBtnState;
    uint8_t  pad1[6];
} xcb_xkb_get_state_reply_t;
```

### Reply function

xcb\_xkb\_get\_state\_reply\_t \***xcb\_xkb\_get\_state\_reply**(xcb\_connection\_t \**conn*, xcb\_xkb\_get\_state\_cookie\_t *cookie*, xcb\_generic\_error\_t \*\**e*);\

## REQUEST ARGUMENTS

- *conn*

  The XCB connection to X11.

- *deviceSpec*

  TODO: NOT YET DOCUMENTED.

## REPLY FIELDS

- *response\_type*

  The type of this reply, in this case *XCB\_XKB\_GET\_STATE*. 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.

- *mods*

  TODO: NOT YET DOCUMENTED.

- *baseMods*

  TODO: NOT YET DOCUMENTED.

- *latchedMods*

  TODO: NOT YET DOCUMENTED.

- *lockedMods*

  TODO: NOT YET DOCUMENTED.

- *group*

  TODO: NOT YET DOCUMENTED.

- *lockedGroup*

  TODO: NOT YET DOCUMENTED.

- *baseGroup*

  TODO: NOT YET DOCUMENTED.

- *latchedGroup*

  TODO: NOT YET DOCUMENTED.

- *compatState*

  TODO: NOT YET DOCUMENTED.

- *grabMods*

  TODO: NOT YET DOCUMENTED.

- *compatGrabMods*

  TODO: NOT YET DOCUMENTED.

- *lookupMods*

  TODO: NOT YET DOCUMENTED.

- *compatLookupMods*

  TODO: NOT YET DOCUMENTED.

- *ptrBtnState*

  TODO: NOT YET DOCUMENTED.

## DESCRIPTION

## RETURN VALUE

Returns an *xcb\_xkb\_get\_state\_cookie\_t*. Errors have to be handled when calling the reply function *xcb\_xkb\_get\_state\_reply*.

If you want to handle errors in the event loop instead, use *xcb\_xkb\_get\_state\_unchecked*. See **[xcb-requests(3)](/xcb-requests/3.md)** for details.

## ERRORS

This request does never generate any errors.

## SEE ALSO

## AUTHOR

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