xcb_x_print_print_get_document_data - Man Page
Synopsis
#include <xcb/xprint.h>
Request function
xcb_x_print_print_get_document_data_cookie_t xcb_x_print_print_get_document_data(xcb_connection_t *conn, xcb_x_print_pcontext_t context, uint32_t max_bytes);
Reply datastructure
typedef struct xcb_x_print_print_get_document_data_reply_t { uint8_t response_type; uint8_t pad0; uint16_t sequence; uint32_t length; uint32_t status_code; uint32_t finished_flag; uint32_t dataLen; uint8_t pad1[12]; } xcb_x_print_print_get_document_data_reply_t;
Reply function
xcb_x_print_print_get_document_data_reply_t *xcb_x_print_print_get_document_data_reply(xcb_connection_t *conn, xcb_x_print_print_get_document_data_cookie_t cookie, xcb_generic_error_t **e);
Reply accessors
uint8_t *xcb_x_print_print_get_document_data_data(const xcb_x_print_print_get_document_data_request_t *reply);
int xcb_x_print_print_get_document_data_data_length(const xcb_x_print_print_get_document_data_reply_t *reply);
xcb_generic_iterator_t xcb_x_print_print_get_document_data_data_end(const xcb_x_print_print_get_document_data_reply_t *reply);
Request Arguments
- conn
The XCB connection to X11.
- context
TODO: NOT YET DOCUMENTED.
- max_bytes
TODO: NOT YET DOCUMENTED.
Reply Fields
- response_type
The type of this reply, in this case XCB_X_PRINT_PRINT_GET_DOCUMENT_DATA. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other.
- sequence
The sequence number of the last request processed by the X11 server.
- length
The length of the reply, in words (a word is 4 bytes).
- status_code
TODO: NOT YET DOCUMENTED.
- finished_flag
TODO: NOT YET DOCUMENTED.
- dataLen
TODO: NOT YET DOCUMENTED.
Description
Return Value
Returns an xcb_x_print_print_get_document_data_cookie_t. Errors have to be handled when calling the reply function xcb_x_print_print_get_document_data_reply.
If you want to handle errors in the event loop instead, use xcb_x_print_print_get_document_data_unchecked. See xcb-requests(3) for details.
Errors
This request does never generate any errors.
See Also
Author
Generated from xprint.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.
Referenced By
The man pages xcb_x_print_print_get_document_data_data(3), xcb_x_print_print_get_document_data_data_end(3), xcb_x_print_print_get_document_data_data_length(3), xcb_x_print_print_get_document_data_reply(3) and xcb_x_print_print_get_document_data_unchecked(3) are aliases of xcb_x_print_print_get_document_data(3).