blob: 836d4003968080d7a60ddd8fbee9ea650189cc6d [file] [log] [blame]
developer5c2422b2024-03-08 00:27:44 +08001/* FILE NAME: air_error.h
2 * PURPOSE:
3 * Define the error code in AIR SDK.
4 * NOTES:
5 */
6
7#ifndef AIR_ERROR_H
8#define AIR_ERROR_H
9
10/* INCLUDE FILE DECLARATIONS
11 */
12
13/* NAMING CONSTANT DECLARATIONS
14 */
15
16/* MACRO FUNCTION DECLARATIONS
17 */
18
19/* DATA TYPE DECLARATIONS
20 */
21typedef enum
22{
23 AIR_E_OK = 0, /* Ok and no error */
24 AIR_E_OTHERS, /* Operation is unsuccessful */
25 AIR_E_BAD_PARAMETER, /* Parameter is wrong */
26 AIR_E_TABLE_FULL, /* Table is full */
27 AIR_E_ENTRY_NOT_FOUND, /* Entry is not found */
28 AIR_E_ENTRY_EXISTS, /* Entry already exists */
29 AIR_E_NOT_SUPPORT, /* Feature is not supported */
30 AIR_E_TIMEOUT, /* Time out error */
31 AIR_E_LAST
32} AIR_ERROR_NO_T;
33
34/* EXPORTED SUBPROGRAM SPECIFICATIONS
35 */
36/* FUNCTION NAME: air_error_getString
37 * PURPOSE:
38 * To obtain the error string of the specified error code
39 *
40 * INPUT:
41 * cause -- The specified error code
42 * OUTPUT:
43 * None
44 * RETURN:
45 * Pointer to the target error string
46 *
47 * NOTES:
48 *
49 *
50 */
51C8_T *
52air_error_getString(
53 const AIR_ERROR_NO_T cause );
54
55#endif /* AIR_ERROR_H */
56