xcb_ungrab_key man page

xcb_ungrab_key — release a key combination

Synopsis

#include <xcb/xproto.h>

Request function

xcb_void_cookie_t xcb_ungrab_key(xcb_connection_t *conn, xcb_keycode_t key, xcb_window_t grab_window, uint16_t modifiers);

Request Arguments

conn

The XCB connection to X11.

key

The keycode of the specified key combination.

Using the special value XCB_GRAB_ANY means releasing all possible key codes.

grab_window

The window on which the grabbed key combination will be released.

modifiers

The modifiers of the specified key combination.

Using the special value XCB_MOD_MASK_ANY means releasing the key combination with every possible modifier combination.

Description

Releases the key combination on grab_window if you grabbed it using xcb_grab_key before.

Return Value

Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the event loop.

If you want to handle errors directly with xcb_request_check instead, use xcb_ungrab_key_checked. See xcb-requests(3) for details.

Errors

xcb_value_error_t

TODO: reasons?

xcb_window_error_t

The specified grab_window does not exist.

See Also

xcb-requests(3), xcb_grab_key(3), xev(1)

Author

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

Referenced By

The man page xcb_ungrab_key_checked(3) is an alias of xcb_ungrab_key(3).

libxcb 1.12 X Version 11 XCB Requests