libguac 1.5.5
Loading...
Searching...
No Matches
Macros | Functions
error.h File Reference

Provides functions and structures required for handling return values and errors. More...

Go to the source code of this file.

Macros

#define guac_error   (*__guac_error())
 Returns the status code associated with the error which occurred during the last function call.
 
#define guac_error_message   (*__guac_error_message())
 Returns a message describing the error which occurred during the last function call.
 
#define guac_error   (*__guac_error())
 Returns the status code associated with the error which occurred during the last function call.
 
#define guac_error_message   (*__guac_error_message())
 Returns a message describing the error which occurred during the last function call.
 

Functions

const char * guac_status_string (guac_status status)
 Returns a human-readable explanation of the status code given.
 

Detailed Description

Provides functions and structures required for handling return values and errors.

Macro Definition Documentation

◆ guac_error [1/2]

#define guac_error   (*__guac_error())

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.

◆ guac_error [2/2]

#define guac_error   (*__guac_error())

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.

◆ guac_error_message [1/2]

#define guac_error_message   (*__guac_error_message())

Returns a message describing the error which occurred during the last function call.

If an error occurred, but no message is associated with it, NULL is returned. This value is undefined if no error occurred.

The storage of this value is thread-local. Assignment of a message to guac_error_message in one thread will not affect its value in another thread.

◆ guac_error_message [2/2]

#define guac_error_message   (*__guac_error_message())

Returns a message describing the error which occurred during the last function call.

If an error occurred, but no message is associated with it, NULL is returned. This value is undefined if no error occurred.

The storage of this value is thread-local. Assignment of a message to guac_error_message in one thread will not affect its value in another thread.