xcb\_shape\_get\_rectangles(3) XCB Requests xcb\_shape\_get\_rectangles(3)

# [NAME](#NAME)

xcb\_shape\_get\_rectangles -

# [SYNOPSIS](#SYNOPSIS)

**#include <xcb/shape.h>**

## [Request function](#Request_function)

xcb\_shape\_get\_rectangles\_cookie\_t **xcb\_shape\_get\_rectangles**(xcb\_connection\_t \**conn*, xcb\_window\_t *window*, xcb\_shape\_kind\_t *source\_kind*);

## [Reply datastructure](#Reply_datastructure)

```
typedef struct xcb_shape_get_rectangles_reply_t {


    uint8_t  response_type;


    uint8_t  ordering;


    uint16_t sequence;


    uint32_t length;


    uint32_t rectangles_len;


    uint8_t  pad0[20];
} xcb_shape_get_rectangles_reply_t;
```

## [Reply function](#Reply_function)

xcb\_shape\_get\_rectangles\_reply\_t \***xcb\_shape\_get\_rectangles\_reply**(xcb\_connection\_t \**conn*, xcb\_shape\_get\_rectangles\_cookie\_t *cookie*, xcb\_generic\_error\_t \*\**e*);

## [Reply accessors](#Reply_accessors)

xcb\_rectangle\_t \***xcb\_shape\_get\_rectangles\_rectangles**(const xcb\_shape\_get\_rectangles\_request\_t \**reply*);

int **xcb\_shape\_get\_rectangles\_rectangles\_length**(const xcb\_shape\_get\_rectangles\_reply\_t \**reply*);

xcb\_rectangle\_iterator\_t **xcb\_shape\_get\_rectangles\_rectangles\_iterator**(const xcb\_shape\_get\_rectangles\_reply\_t \**reply*);

# [REQUEST ARGUMENTS](#REQUEST_ARGUMENTS)

[*conn*](#conn)

The XCB connection to X11.

[*window*](#window)

TODO: NOT YET DOCUMENTED.

[*source\_kind*](#source_kind)

TODO: NOT YET DOCUMENTED.

# [REPLY FIELDS](#REPLY_FIELDS)

[*response\_type*](#response_type)

The type of this reply, in this case *XCB\_SHAPE\_GET\_RECTANGLES*. This field is also present in the *xcb\_generic\_reply\_t* and can be used to tell replies apart from each other.

[*sequence*](#sequence)

The sequence number of the last request processed by the X11 server.

[*length*](#length)

The length of the reply, in words (a word is 4 bytes).

[*ordering*](#ordering)

TODO: NOT YET DOCUMENTED.

[*rectangles\_len*](#rectangles_len)

TODO: NOT YET DOCUMENTED.

# [DESCRIPTION](#DESCRIPTION)

# [RETURN VALUE](#RETURN_VALUE)

Returns an *xcb\_shape\_get\_rectangles\_cookie\_t*. Errors have to be handled when calling the reply function *xcb\_shape\_get\_rectangles\_reply*.

If you want to handle errors in the event loop instead, use *xcb\_shape\_get\_rectangles\_unchecked*. See [**xcb-requests(3)**](/man/os/libxcb/xcb-requests.3) for details.

# [ERRORS](#ERRORS)

This request does never generate any errors.

# [SEE ALSO](#SEE_ALSO)

# [AUTHOR](#AUTHOR)

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

libxcb 1.17.0 X Version 11

---

Document: xcb_shape_get_rectangles_rectangles_iterator(3) from libxcb 1.17.0-r18 (Chainguard OS)
Source: https://gitlab.freedesktop.org/xorg/lib/libxcb.git