.TH xcb_shape_get_rectangles 3  "libxcb 1.13" "X Version 11" "XCB Requests"
.ad l
.SH NAME
xcb_shape_get_rectangles \- 
.SH SYNOPSIS
.hy 0
.B #include <xcb/shape.h>
.SS Request function
.HP
xcb_shape_get_rectangles_cookie_t \fBxcb_shape_get_rectangles\fP(xcb_connection_t\ *\fIconn\fP, xcb_window_t\ \fIwindow\fP, xcb_shape_kind_t\ \fIsource_kind\fP);
.PP
.SS Reply datastructure
.nf
.sp
typedef struct xcb_shape_get_rectangles_reply_t {
    uint8_t  \fIresponse_type\fP;
    uint8_t  \fIordering\fP;
    uint16_t \fIsequence\fP;
    uint32_t \fIlength\fP;
    uint32_t \fIrectangles_len\fP;
    uint8_t  \fIpad0\fP[20];
} \fBxcb_shape_get_rectangles_reply_t\fP;
.fi
.SS Reply function
.HP
xcb_shape_get_rectangles_reply_t *\fBxcb_shape_get_rectangles_reply\fP(xcb_connection_t\ *\fIconn\fP, xcb_shape_get_rectangles_cookie_t\ \fIcookie\fP, xcb_generic_error_t\ **\fIe\fP);
.SS Reply accessors
.HP
xcb_rectangle_t *\fBxcb_shape_get_rectangles_rectangles\fP(const xcb_shape_get_rectangles_request_t *\fIreply\fP);
.HP
int \fBxcb_shape_get_rectangles_rectangles_length\fP(const xcb_shape_get_rectangles_reply_t *\fIreply\fP);
.HP
xcb_rectangle_iterator_t \fBxcb_shape_get_rectangles_rectangles_iterator\fP(const xcb_shape_get_rectangles_reply_t *\fIreply\fP);
.br
.hy 1
.SH REQUEST ARGUMENTS
.IP \fIconn\fP 1i
The XCB connection to X11.
.IP \fIwindow\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIsource_kind\fP 1i
TODO: NOT YET DOCUMENTED.
.SH REPLY FIELDS
.IP \fIresponse_type\fP 1i
The type of this reply, in this case \fIXCB_SHAPE_GET_RECTANGLES\fP. This field is also present in the \fIxcb_generic_reply_t\fP and can be used to tell replies apart from each other.
.IP \fIsequence\fP 1i
The sequence number of the last request processed by the X11 server.
.IP \fIlength\fP 1i
The length of the reply, in words (a word is 4 bytes).
.IP \fIordering\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIrectangles_len\fP 1i
TODO: NOT YET DOCUMENTED.
.SH DESCRIPTION
.SH RETURN VALUE
Returns an \fIxcb_shape_get_rectangles_cookie_t\fP. Errors have to be handled when calling the reply function \fIxcb_shape_get_rectangles_reply\fP.

If you want to handle errors in the event loop instead, use \fIxcb_shape_get_rectangles_unchecked\fP. See \fBxcb-requests(3)\fP for details.
.SH ERRORS
This request does never generate any errors.
.SH SEE ALSO
.SH AUTHOR
Generated from shape.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.
