xcb_change_save_set(3)

1xcb_change_save_set(3)           XCB Requests           xcb_change_save_set(3)
2
3
4

NAME

6       xcb_change_save_set - Changes a client's save set
7

SYNOPSIS

9       #include <xcb/xproto.h>
10
11   Request function
12       xcb_void_cookie_t xcb_change_save_set(xcb_connection_t *conn,
13              uint8_t mode, xcb_window_t window);
14

REQUEST ARGUMENTS

16       conn      The XCB connection to X11.
17
18       mode      One of the following values:
19
20                 XCB_SET_MODE_INSERT
21                           TODO: NOT YET DOCUMENTED.
22
23                 XCB_SET_MODE_DELETE
24                           TODO: NOT YET DOCUMENTED.
25
26                 Insert to add the specified window to the save set or Delete
27                 to delete it from the save set.
28
29       window    The window to add or delete to/from your save set.
30

DESCRIPTION

32       TODO: explain what the save set is for.
33
34       This function either adds or removes the specified window to the
35       client's (your application's) save set.
36

RETURN VALUE

38       Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the
39       event loop.
40
41       If you want to handle errors directly with xcb_request_check instead,
42       use xcb_change_save_set_checked. See xcb-requests(3) for details.
43

ERRORS

45       xcb_match_error_t
46                 You created the specified window. This does not make sense,
47                 you can only add windows created by other clients to your
48                 save set.
49
50       xcb_value_error_t
51                 You specified an invalid mode.
52
53       xcb_window_error_t
54                 The specified window does not exist.
55

AUTHOR

60       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
61       rections and improvements.
62
63
64
65X Version 11                     libxcb 1.13.1          xcb_change_save_set(3)