OSAPI  0.29
Open System API
status_types.h
1 // *****************************************************************************************
2 //
3 // File description:
4 //
5 // Author: Joao Costa
6 // Purpose: Status module declarations
7 //
8 // *****************************************************************************************
9 
10 #ifndef OSAPI_STATUS_TYPES_H_
11 #define OSAPI_STATUS_TYPES_H_
12 
13 
14 // *****************************************************************************************
15 //
16 // Section: Import headers
17 //
18 // *****************************************************************************************
19 
20 // Force baseline before system headers
21 #include "general/general_baseline.h"
22 
23 // System headers
24 #include <stdint.h>
25 
26 // OSAPI headers
27 #include "general/general_types.h"
28 #include "error/error_types.h"
29 
30 
39 
40 // *****************************************************************************************
41 //
42 // Section: Type declarations
43 //
44 // *****************************************************************************************
45 
47 typedef int t_status_type;
48 
50 typedef const char * t_status_string;
51 
53 typedef const char * t_status_funcname;
54 
57 {
60 
61  // Error information
62  union
63  {
65  t_error code;
66 
69  };
70 
75 };
76 
78 typedef struct osapi_status_S t_status;
79 
82 
83 
84 #endif /* OSAPI_STATUS_TYPES_H_ */
osapi_status_S
Definition of opaque status type.
Definition: status_types.h:56
osapi_status_S::funcname
t_status_funcname funcname
Function name that provides the status.
Definition: status_types.h:74
osapi_status_S::type
t_status_type type
For which library is the status available.
Definition: status_types.h:59
t_module
Byte t_module
Definition of the module type.
Definition: general_types.h:69
t_status_funcname
const typedef char * t_status_funcname
Function name type.
Definition: status_types.h:53
osapi_status_S::module
t_module module
Module that provides the status.
Definition: status_types.h:72
t_status_string
const typedef char * t_status_string
Error string type.
Definition: status_types.h:50
osapi_status_S::code
t_error code
The status can be provided by an error code.
Definition: status_types.h:65
osapi_status_S::string
t_status_string string
The error can also be provided through a string directly.
Definition: status_types.h:68
t_status_type
int t_status_type
Library identifier type (OSAPI, libc, etc.)
Definition: status_types.h:47