---
name: "xcb_circulate_window_checked"
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_circulate_window"
---

# xcb\_circulate\_window\_checked(3)

Change window stacking order

Part of [xcb\_circulate\_window(3)](/xcb_circulate_window/3.md).

## NAME

xcb\_circulate\_window - Change window stacking order

## SYNOPSIS

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

### Request function

xcb\_void\_cookie\_t **xcb\_circulate\_window**(xcb\_connection\_t \**conn*, uint8\_t *direction*, xcb\_window\_t *window*);\

## REQUEST ARGUMENTS

- *conn*

  The XCB connection to X11.

- *direction*

  One of the following values:

  - *XCB\_CIRCULATE\_RAISE\_LOWEST*

    TODO: NOT YET DOCUMENTED.

  - *XCB\_CIRCULATE\_LOWER\_HIGHEST*

    TODO: NOT YET DOCUMENTED.

- *window*

  The window to raise/lower (depending on *direction*).

## DESCRIPTION

If *direction* is *XCB\_CIRCULATE\_RAISE\_LOWEST*, the lowest mapped child (if any) will be raised to the top of the stack.

If *direction* is *XCB\_CIRCULATE\_LOWER\_HIGHEST*, the highest mapped child will be lowered to the bottom of the stack.

## 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\_circulate\_window\_checked*. See **[xcb-requests(3)](/xcb-requests/3.md)** for details.

## ERRORS

- *xcb\_value\_error\_t*

  The specified *direction* is invalid.

- *xcb\_window\_error\_t*

  The specified *window* does not exist.

## SEE ALSO

[**xcb-requests**(3)](/xcb-requests/3.md)

## AUTHOR

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