---
name: "xcb_composite_redirect_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_composite_redirect_window"
---

# xcb\_composite\_redirect\_window\_checked(3)

Redirect the hierarchy starting at "window" to off-screen storage.

Part of [xcb\_composite\_redirect\_window(3)](/xcb_composite_redirect_window/3.md).

## NAME

xcb\_composite\_redirect\_window - Redirect the hierarchy starting at "window" to off-screen storage.

## SYNOPSIS

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

### Request function

xcb\_void\_cookie\_t **xcb\_composite\_redirect\_window**(xcb\_connection\_t \**conn*, xcb\_window\_t *window*, uint8\_t *update*);\

## REQUEST ARGUMENTS

- *conn*

  The XCB connection to X11.

- *window*

  The root of the hierarchy to redirect to off-screen storage.

- *update*

  Whether contents are automatically mirrored to the parent window.  If one client\
   	already specifies an update type of Manual, any attempt by another to specify a\
   	mode of Manual so will result in an Access error.

## DESCRIPTION

The hierarchy starting at 'window' is directed to off-screen\
 	storage.  When all clients enabling redirection terminate,\
 	the redirection will automatically be disabled.

	The root window may not be redirected. Doing so results in a Match\
 	error.

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

## ERRORS

This request does never generate any errors.

## SEE ALSO

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

## AUTHOR

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