Include dependency graph for status.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Typedefs | |
| typedef struct _LDStatus * | LDStatus |
Functions | |
| LDStatus_Error (LDStatus res) | |
| LDStatus_Ok (LDStatus res) | |
| LDStatus_Free (LDStatus res) | |
| LDStatus_Success (void) | |
Function Documentation
◆ LDStatus_Error()
| LDStatus_Error | ( | LDStatus | res | ) |
Returns a string representing the error stored in an LDStatus, or NULL if the result indicates success.
- Parameters
-
res Result to inspect.
- Returns
- String or NULL. The returned string is valid only while the LDStatus is alive.
◆ LDStatus_Free()
| LDStatus_Free | ( | LDStatus | res | ) |
Frees an LDStatus. It is only necessary to call if LDStatus_Ok returns false.
- Parameters
-
res Result to free.
◆ LDStatus_Ok()
| LDStatus_Ok | ( | LDStatus | res | ) |
Checks if a result indicates success.
- Parameters
-
res Result to inspect.
- Returns
- True if the result indicates success.
◆ LDStatus_Success()
| LDStatus_Success | ( | void | ) |
Returns a status representing success.
- Returns
- Successful status.
