Added documentation for guac_error

This commit is contained in:
Michael Jumper 2011-11-21 01:37:16 -08:00
parent 797c30de75
commit 40f773e733

View File

@ -98,6 +98,14 @@ typedef enum guac_status {
*/
const char* guac_status_string(guac_status status);
/**
* Returns the status code associated with the error which occurred during the
* last function call. This value will only be set by functions documented to
* use it (most libguac functions), and is undefined if no error occurred.
*
* The storage of this value is thread-local. Assignment of a status code to
* guac_error in one thread will not affect its value in another thread.
*/
#define guac_error (*__guac_error())
guac_status* __guac_error();