Document failure scenarios for *_new()

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2015-04-04 16:46:07 +02:00
parent 862579778a
commit 322f2e1b81

View file

@ -49,7 +49,8 @@ typedef struct xcb_errors_context_t xcb_errors_context_t;
* with @ref xcb_errors_context_free ().
* @param ctx A pointer to an xcb_cursor_context_t* which will be modified to
* refer to the newly created context.
* @return 0 on success, some other value otherwise.
* @return 0 on success, -1 otherwise. This function may fail due to memory
* allocation failures or if the connection ends up in an error state.
*/
int xcb_errors_context_new(xcb_connection_t *conn, xcb_errors_context_t **ctx);