xcb_change_save_set(3)

xcb_change_save_set3

Changes a client's save set

Usage

#include <xcb/xproto.h>

Request function

xcb_void_cookie_t xcb_change_save_set(xcb_connection_t *conn, uint8_t mode, xcb_window_t window);

Request arguments

conn

The XCB connection to X11.

mode

One of the following values:

XCB_SET_MODE_INSERT

TODO: NOT YET DOCUMENTED.

XCB_SET_MODE_DELETE

TODO: NOT YET DOCUMENTED.

Insert to add the specified window to the save set or Delete to delete it from the save set.

window

The window to add or delete to/from your save set.

Overview

TODO: explain what the save set is for.

This function either adds or removes the specified window to the client's (your application's) save set.

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_change_save_set_checked. See xcb-requests(3) for details.

Errors

xcb_match_error_t

You created the specified window. This does not make sense, you can only add windows created by other clients to your save set.

xcb_value_error_t

You specified an invalid mode.

xcb_window_error_t

The specified window does not exist.

Releases

6 releases since Debian 9 (Stretch); the text changed 4 times.

  1. 9
  2. 10
  3. 11
  4. 12
  5. 13–Arch

Author

Generated from xproto.xml. Contact [email protected] for corrections and improvements.

From libxcb 1.17.0-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.