XCB  1.9
Data Structures | Macros | Typedefs | Functions | Variables
XCB Res API

Res XCB Protocol Implementation. More...

Data Structures

struct  xcb_res_client_t
 xcb_res_client_t More...
struct  xcb_res_client_iterator_t
 xcb_res_client_iterator_t More...
struct  xcb_res_type_t
 xcb_res_type_t More...
struct  xcb_res_type_iterator_t
 xcb_res_type_iterator_t More...
struct  xcb_res_query_version_cookie_t
 xcb_res_query_version_cookie_t More...
struct  xcb_res_query_version_request_t
 xcb_res_query_version_request_t More...
struct  xcb_res_query_version_reply_t
 xcb_res_query_version_reply_t More...
struct  xcb_res_query_clients_cookie_t
 xcb_res_query_clients_cookie_t More...
struct  xcb_res_query_clients_request_t
 xcb_res_query_clients_request_t More...
struct  xcb_res_query_clients_reply_t
 xcb_res_query_clients_reply_t More...
struct  xcb_res_query_client_resources_cookie_t
 xcb_res_query_client_resources_cookie_t More...
struct  xcb_res_query_client_resources_request_t
 xcb_res_query_client_resources_request_t More...
struct  xcb_res_query_client_resources_reply_t
 xcb_res_query_client_resources_reply_t More...
struct  xcb_res_query_client_pixmap_bytes_cookie_t
 xcb_res_query_client_pixmap_bytes_cookie_t More...
struct  xcb_res_query_client_pixmap_bytes_request_t
 xcb_res_query_client_pixmap_bytes_request_t More...
struct  xcb_res_query_client_pixmap_bytes_reply_t
 xcb_res_query_client_pixmap_bytes_reply_t More...

Macros

#define XCB_RES_MAJOR_VERSION   1
#define XCB_RES_MINOR_VERSION   0
#define XCB_RES_QUERY_VERSION   0
#define XCB_RES_QUERY_CLIENTS   1
#define XCB_RES_QUERY_CLIENT_RESOURCES   2
#define XCB_RES_QUERY_CLIENT_PIXMAP_BYTES   3

Typedefs

typedef struct xcb_res_client_t xcb_res_client_t
 xcb_res_client_t
typedef struct
xcb_res_client_iterator_t 
xcb_res_client_iterator_t
 xcb_res_client_iterator_t
typedef struct xcb_res_type_t xcb_res_type_t
 xcb_res_type_t
typedef struct
xcb_res_type_iterator_t 
xcb_res_type_iterator_t
 xcb_res_type_iterator_t
typedef struct
xcb_res_query_version_cookie_t 
xcb_res_query_version_cookie_t
 xcb_res_query_version_cookie_t
typedef struct
xcb_res_query_version_request_t 
xcb_res_query_version_request_t
 xcb_res_query_version_request_t
typedef struct
xcb_res_query_version_reply_t 
xcb_res_query_version_reply_t
 xcb_res_query_version_reply_t
typedef struct
xcb_res_query_clients_cookie_t 
xcb_res_query_clients_cookie_t
 xcb_res_query_clients_cookie_t
typedef struct
xcb_res_query_clients_request_t 
xcb_res_query_clients_request_t
 xcb_res_query_clients_request_t
typedef struct
xcb_res_query_clients_reply_t 
xcb_res_query_clients_reply_t
 xcb_res_query_clients_reply_t
typedef struct
xcb_res_query_client_resources_cookie_t 
xcb_res_query_client_resources_cookie_t
 xcb_res_query_client_resources_cookie_t
typedef struct
xcb_res_query_client_resources_request_t 
xcb_res_query_client_resources_request_t
 xcb_res_query_client_resources_request_t
typedef struct
xcb_res_query_client_resources_reply_t 
xcb_res_query_client_resources_reply_t
 xcb_res_query_client_resources_reply_t
typedef struct
xcb_res_query_client_pixmap_bytes_cookie_t 
xcb_res_query_client_pixmap_bytes_cookie_t
 xcb_res_query_client_pixmap_bytes_cookie_t
typedef struct
xcb_res_query_client_pixmap_bytes_request_t 
xcb_res_query_client_pixmap_bytes_request_t
 xcb_res_query_client_pixmap_bytes_request_t
typedef struct
xcb_res_query_client_pixmap_bytes_reply_t 
xcb_res_query_client_pixmap_bytes_reply_t
 xcb_res_query_client_pixmap_bytes_reply_t

Functions

void xcb_res_client_next (xcb_res_client_iterator_t *i)
xcb_generic_iterator_t xcb_res_client_end (xcb_res_client_iterator_t i)
void xcb_res_type_next (xcb_res_type_iterator_t *i)
xcb_generic_iterator_t xcb_res_type_end (xcb_res_type_iterator_t i)
xcb_res_query_version_cookie_t xcb_res_query_version (xcb_connection_t *c, uint8_t client_major, uint8_t client_minor)
xcb_res_query_version_cookie_t xcb_res_query_version_unchecked (xcb_connection_t *c, uint8_t client_major, uint8_t client_minor)
xcb_res_query_version_reply_txcb_res_query_version_reply (xcb_connection_t *c, xcb_res_query_version_cookie_t cookie, xcb_generic_error_t **e)
int xcb_res_query_clients_sizeof (const void *_buffer)
xcb_res_query_clients_cookie_t xcb_res_query_clients (xcb_connection_t *c)
xcb_res_query_clients_cookie_t xcb_res_query_clients_unchecked (xcb_connection_t *c)
xcb_res_client_txcb_res_query_clients_clients (const xcb_res_query_clients_reply_t *R)
int xcb_res_query_clients_clients_length (const xcb_res_query_clients_reply_t *R)
xcb_res_client_iterator_t xcb_res_query_clients_clients_iterator (const xcb_res_query_clients_reply_t *R)
xcb_res_query_clients_reply_txcb_res_query_clients_reply (xcb_connection_t *c, xcb_res_query_clients_cookie_t cookie, xcb_generic_error_t **e)
int xcb_res_query_client_resources_sizeof (const void *_buffer)
xcb_res_query_client_resources_cookie_t xcb_res_query_client_resources (xcb_connection_t *c, uint32_t xid)
xcb_res_query_client_resources_cookie_t xcb_res_query_client_resources_unchecked (xcb_connection_t *c, uint32_t xid)
xcb_res_type_txcb_res_query_client_resources_types (const xcb_res_query_client_resources_reply_t *R)
int xcb_res_query_client_resources_types_length (const xcb_res_query_client_resources_reply_t *R)
xcb_res_type_iterator_t xcb_res_query_client_resources_types_iterator (const xcb_res_query_client_resources_reply_t *R)
xcb_res_query_client_resources_reply_txcb_res_query_client_resources_reply (xcb_connection_t *c, xcb_res_query_client_resources_cookie_t cookie, xcb_generic_error_t **e)
xcb_res_query_client_pixmap_bytes_cookie_t xcb_res_query_client_pixmap_bytes (xcb_connection_t *c, uint32_t xid)
xcb_res_query_client_pixmap_bytes_cookie_t xcb_res_query_client_pixmap_bytes_unchecked (xcb_connection_t *c, uint32_t xid)
xcb_res_query_client_pixmap_bytes_reply_txcb_res_query_client_pixmap_bytes_reply (xcb_connection_t *c, xcb_res_query_client_pixmap_bytes_cookie_t cookie, xcb_generic_error_t **e)

Variables

xcb_extension_t xcb_res_id

Detailed Description

Res XCB Protocol Implementation.


Macro Definition Documentation

#define XCB_RES_QUERY_CLIENT_PIXMAP_BYTES   3

Opcode for xcb_res_query_client_pixmap_bytes.

Referenced by xcb_res_query_client_pixmap_bytes(), and xcb_res_query_client_pixmap_bytes_unchecked().

#define XCB_RES_QUERY_CLIENT_RESOURCES   2

Opcode for xcb_res_query_client_resources.

Referenced by xcb_res_query_client_resources(), and xcb_res_query_client_resources_unchecked().

#define XCB_RES_QUERY_CLIENTS   1

Opcode for xcb_res_query_clients.

Referenced by xcb_res_query_clients(), and xcb_res_query_clients_unchecked().

#define XCB_RES_QUERY_VERSION   0

Opcode for xcb_res_query_version.

Referenced by xcb_res_query_version(), and xcb_res_query_version_unchecked().


Function Documentation

Return the iterator pointing to the last element

Parameters:
iAn xcb_res_client_iterator_t
Returns:
The iterator pointing to the last element

Set the current element in the iterator to the last element. The member rem is set to 0. The member data points to the last element.

References xcb_res_client_iterator_t::data, xcb_generic_iterator_t::data, xcb_res_client_iterator_t::index, xcb_generic_iterator_t::index, xcb_res_client_iterator_t::rem, and xcb_generic_iterator_t::rem.

void xcb_res_client_next ( xcb_res_client_iterator_t i)

Get the next element of the iterator

Parameters:
iPointer to a xcb_res_client_iterator_t

Get the next element in the iterator. The member rem is decreased by one. The member data points to the next element. The member index is increased by sizeof(xcb_res_client_t)

References xcb_res_client_iterator_t::data, xcb_res_client_iterator_t::index, and xcb_res_client_iterator_t::rem.

xcb_res_query_client_pixmap_bytes_cookie_t xcb_res_query_client_pixmap_bytes ( xcb_connection_t c,
uint32_t  xid 
)
Parameters:
cThe connection
Returns:
A cookie

Delivers a request to the X server.

References XCB_RES_QUERY_CLIENT_PIXMAP_BYTES, and xcb_res_query_client_pixmap_bytes_request_t::xid.

Return the reply

Parameters:
cThe connection
cookieThe cookie
eThe xcb_generic_error_t supplied

Returns the reply of the request asked by

The parameter e supplied to this function must be NULL if xcb_res_query_client_pixmap_bytes_unchecked(). is used. Otherwise, it stores the error if any.

The returned value must be freed by the caller using free().

References xcb_res_query_client_pixmap_bytes_cookie_t::sequence.

xcb_res_query_client_pixmap_bytes_cookie_t xcb_res_query_client_pixmap_bytes_unchecked ( xcb_connection_t c,
uint32_t  xid 
)
Parameters:
cThe connection
Returns:
A cookie

Delivers a request to the X server.

This form can be used only if the request will cause a reply to be generated. Any returned error will be placed in the event queue.

References XCB_RES_QUERY_CLIENT_PIXMAP_BYTES, and xcb_res_query_client_pixmap_bytes_request_t::xid.

xcb_res_query_client_resources_cookie_t xcb_res_query_client_resources ( xcb_connection_t c,
uint32_t  xid 
)
Parameters:
cThe connection
Returns:
A cookie

Delivers a request to the X server.

References XCB_RES_QUERY_CLIENT_RESOURCES, and xcb_res_query_client_resources_request_t::xid.

Return the reply

Parameters:
cThe connection
cookieThe cookie
eThe xcb_generic_error_t supplied

Returns the reply of the request asked by

The parameter e supplied to this function must be NULL if xcb_res_query_client_resources_unchecked(). is used. Otherwise, it stores the error if any.

The returned value must be freed by the caller using free().

References xcb_res_query_client_resources_cookie_t::sequence.

xcb_res_query_client_resources_cookie_t xcb_res_query_client_resources_unchecked ( xcb_connection_t c,
uint32_t  xid 
)
Parameters:
cThe connection
Returns:
A cookie

Delivers a request to the X server.

This form can be used only if the request will cause a reply to be generated. Any returned error will be placed in the event queue.

References XCB_RES_QUERY_CLIENT_RESOURCES, and xcb_res_query_client_resources_request_t::xid.

xcb_res_query_clients_cookie_t xcb_res_query_clients ( xcb_connection_t c)
Parameters:
cThe connection
Returns:
A cookie

Delivers a request to the X server.

References XCB_RES_QUERY_CLIENTS.

xcb_res_query_clients_reply_t* xcb_res_query_clients_reply ( xcb_connection_t c,
xcb_res_query_clients_cookie_t  cookie,
xcb_generic_error_t **  e 
)

Return the reply

Parameters:
cThe connection
cookieThe cookie
eThe xcb_generic_error_t supplied

Returns the reply of the request asked by

The parameter e supplied to this function must be NULL if xcb_res_query_clients_unchecked(). is used. Otherwise, it stores the error if any.

The returned value must be freed by the caller using free().

References xcb_res_query_clients_cookie_t::sequence.

xcb_res_query_clients_cookie_t xcb_res_query_clients_unchecked ( xcb_connection_t c)
Parameters:
cThe connection
Returns:
A cookie

Delivers a request to the X server.

This form can be used only if the request will cause a reply to be generated. Any returned error will be placed in the event queue.

References XCB_RES_QUERY_CLIENTS.

xcb_res_query_version_cookie_t xcb_res_query_version ( xcb_connection_t c,
uint8_t  client_major,
uint8_t  client_minor 
)
Parameters:
cThe connection
Returns:
A cookie

Delivers a request to the X server.

References xcb_res_query_version_request_t::client_major, xcb_res_query_version_request_t::client_minor, and XCB_RES_QUERY_VERSION.

xcb_res_query_version_reply_t* xcb_res_query_version_reply ( xcb_connection_t c,
xcb_res_query_version_cookie_t  cookie,
xcb_generic_error_t **  e 
)

Return the reply

Parameters:
cThe connection
cookieThe cookie
eThe xcb_generic_error_t supplied

Returns the reply of the request asked by

The parameter e supplied to this function must be NULL if xcb_res_query_version_unchecked(). is used. Otherwise, it stores the error if any.

The returned value must be freed by the caller using free().

References xcb_res_query_version_cookie_t::sequence.

xcb_res_query_version_cookie_t xcb_res_query_version_unchecked ( xcb_connection_t c,
uint8_t  client_major,
uint8_t  client_minor 
)
Parameters:
cThe connection
Returns:
A cookie

Delivers a request to the X server.

This form can be used only if the request will cause a reply to be generated. Any returned error will be placed in the event queue.

References xcb_res_query_version_request_t::client_major, xcb_res_query_version_request_t::client_minor, and XCB_RES_QUERY_VERSION.

Return the iterator pointing to the last element

Parameters:
iAn xcb_res_type_iterator_t
Returns:
The iterator pointing to the last element

Set the current element in the iterator to the last element. The member rem is set to 0. The member data points to the last element.

References xcb_res_type_iterator_t::data, xcb_generic_iterator_t::data, xcb_res_type_iterator_t::index, xcb_generic_iterator_t::index, xcb_res_type_iterator_t::rem, and xcb_generic_iterator_t::rem.

void xcb_res_type_next ( xcb_res_type_iterator_t i)

Get the next element of the iterator

Parameters:
iPointer to a xcb_res_type_iterator_t

Get the next element in the iterator. The member rem is decreased by one. The member data points to the next element. The member index is increased by sizeof(xcb_res_type_t)

References xcb_res_type_iterator_t::data, xcb_res_type_iterator_t::index, and xcb_res_type_iterator_t::rem.