51Degrees Device Detection C/C++  4.2

A device detection library that is used natively or by 51Degrees products

status.h

1 /* *********************************************************************
2  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
4  * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
5  *
6  * This Original Work is licensed under the European Union Public Licence (EUPL)
7  * v.1.2 and is subject to its terms as set out below.
8  *
9  * If a copy of the EUPL was not distributed with this file, You can obtain
10  * one at https://opensource.org/licenses/EUPL-1.2.
11  *
12  * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
13  * amended by the European Commission) shall be deemed incompatible for
14  * the purposes of the Work and the provisions of the compatibility
15  * clause in Article 5 of the EUPL shall not apply.
16  *
17  * If using the Work as, or as part of, a network application, by
18  * including the attribution notice(s) required under Article 5 of the EUPL
19  * in the end user terms of the application under an appropriate heading,
20  * such notice(s) shall fulfill the requirements of that article.
21  * ********************************************************************* */
22 
23 #ifndef FIFTYONE_DEGREES_INIT_H_INCLUDED
24 #define FIFTYONE_DEGREES_INIT_H_INCLUDED
25 
71 #include <stdint.h>
72 #include <string.h>
73 #include <stdio.h>
74 
75 #ifdef __cplusplus
76 #define EXTERNAL extern "C"
77 #else
78 #define EXTERNAL
79 #endif
80 
82 typedef enum e_fiftyone_degrees_status_code {
83  FIFTYONE_DEGREES_STATUS_SUCCESS,
84  FIFTYONE_DEGREES_STATUS_INSUFFICIENT_MEMORY,
85  FIFTYONE_DEGREES_STATUS_CORRUPT_DATA,
86  FIFTYONE_DEGREES_STATUS_INCORRECT_VERSION,
88  FIFTYONE_DEGREES_STATUS_FILE_NOT_FOUND,
90  FIFTYONE_DEGREES_STATUS_FILE_BUSY,
91  FIFTYONE_DEGREES_STATUS_FILE_FAILURE,
92  FIFTYONE_DEGREES_STATUS_NOT_SET,
94  FIFTYONE_DEGREES_STATUS_POINTER_OUT_OF_BOUNDS,
97  FIFTYONE_DEGREES_STATUS_NULL_POINTER,
98  FIFTYONE_DEGREES_STATUS_TOO_MANY_OPEN_FILES,
99  FIFTYONE_DEGREES_STATUS_REQ_PROP_NOT_PRESENT,
101  FIFTYONE_DEGREES_STATUS_PROFILE_EMPTY,
103  FIFTYONE_DEGREES_STATUS_COLLECTION_FAILURE,
107  FIFTYONE_DEGREES_STATUS_FILE_COPY_ERROR,
109  FIFTYONE_DEGREES_STATUS_FILE_EXISTS_ERROR,
112  FIFTYONE_DEGREES_STATUS_FILE_WRITE_ERROR,
114  FIFTYONE_DEGREES_STATUS_FILE_PERMISSION_DENIED,
115  FIFTYONE_DEGREES_STATUS_FILE_PATH_TOO_LONG,
118  FIFTYONE_DEGREES_STATUS_ENCODING_ERROR,
120  FIFTYONE_DEGREES_STATUS_INVALID_COLLECTION_CONFIG,
125  FIFTYONE_DEGREES_STATUS_INVALID_CONFIG,
126  FIFTYONE_DEGREES_STATUS_INSUFFICIENT_HANDLES,
130  FIFTYONE_DEGREES_STATUS_COLLECTION_INDEX_OUT_OF_RANGE,
132  FIFTYONE_DEGREES_STATUS_COLLECTION_OFFSET_OUT_OF_RANGE,
134  FIFTYONE_DEGREES_STATUS_COLLECTION_FILE_SEEK_FAIL,
135  FIFTYONE_DEGREES_STATUS_COLLECTION_FILE_READ_FAIL,
136  FIFTYONE_DEGREES_STATUS_INCORRECT_IP_ADDRESS_FORMAT
138 } fiftyoneDegreesStatusCode;
139 
149 EXTERNAL const char* fiftyoneDegreesStatusGetMessage(
150  fiftyoneDegreesStatusCode status,
151  const char *fileName);
152 
157 #endif
FIFTYONE_DEGREES_STATUS_FILE_FAILURE
Unknown file error.
Definition: status.h:91
FIFTYONE_DEGREES_STATUS_CORRUPT_DATA
Data structure not readable.
Definition: status.h:85
FIFTYONE_DEGREES_STATUS_FILE_WRITE_ERROR
The data file could not be created.
Definition: status.h:112
FIFTYONE_DEGREES_STATUS_FILE_PERMISSION_DENIED
File permission denied.
Definition: status.h:114
FIFTYONE_DEGREES_STATUS_INVALID_COLLECTION_CONFIG
The configuration provided to create a collection could not be used to create a valid collection.
Definition: status.h:120
fiftyoneDegreesStatusGetMessage
const char * fiftyoneDegreesStatusGetMessage(fiftyoneDegreesStatusCode status, const char *fileName)
Returns an English error message for the status code allocating memory needed to store the message.
fiftyoneDegreesStatusCode
fiftyoneDegreesStatusCode
Status returned from the initialisation of a resource.
Definition: status.h:82
FIFTYONE_DEGREES_STATUS_REQ_PROP_NOT_PRESENT
None of the required properties could be found.
Definition: status.h:99
FIFTYONE_DEGREES_STATUS_COLLECTION_OFFSET_OUT_OF_RANGE
Offset out of range.
Definition: status.h:132
FIFTYONE_DEGREES_STATUS_INSUFFICIENT_HANDLES
There were not enough handles available to retrieve data from the source.
Definition: status.h:126
FIFTYONE_DEGREES_STATUS_POINTER_OUT_OF_BOUNDS
Working pointer exceeded the amount of memory containing the data.
Definition: status.h:94
FIFTYONE_DEGREES_STATUS_COLLECTION_INDEX_OUT_OF_RANGE
Index out of range.
Definition: status.h:130
FIFTYONE_DEGREES_STATUS_COLLECTION_FILE_READ_FAIL
Read failure.
Definition: status.h:135
FIFTYONE_DEGREES_STATUS_INSUFFICIENT_MEMORY
Lack of memory.
Definition: status.h:84
FIFTYONE_DEGREES_STATUS_INCORRECT_IP_ADDRESS_FORMAT
IP address format is incorrect.
Definition: status.h:136
FIFTYONE_DEGREES_STATUS_FILE_BUSY
The data file was busy.
Definition: status.h:90
FIFTYONE_DEGREES_STATUS_NOT_SET
Should never be returned to the caller.
Definition: status.h:92
FIFTYONE_DEGREES_STATUS_INCORRECT_VERSION
Data not the required version.
Definition: status.h:86
FIFTYONE_DEGREES_STATUS_PROFILE_EMPTY
The profile id represents an empty profile.
Definition: status.h:101
FIFTYONE_DEGREES_STATUS_FILE_PATH_TOO_LONG
The file path is longer than the available memory available to store it.
Definition: status.h:115
FIFTYONE_DEGREES_STATUS_COLLECTION_FILE_SEEK_FAIL
Seek failure.
Definition: status.h:134
FIFTYONE_DEGREES_STATUS_FILE_NOT_FOUND
The data file couldn't be found.
Definition: status.h:88
FIFTYONE_DEGREES_STATUS_FILE_EXISTS_ERROR
The file or directory already exists, so could not be created.
Definition: status.h:109
FIFTYONE_DEGREES_STATUS_COLLECTION_FAILURE
There was an error getting an item from a collection due to too many concurrent operations.
Definition: status.h:103
FIFTYONE_DEGREES_STATUS_INVALID_CONFIG
An invalid config was provided.
Definition: status.h:125
FIFTYONE_DEGREES_STATUS_NULL_POINTER
A key pointer was not set.
Definition: status.h:97
FIFTYONE_DEGREES_STATUS_SUCCESS
All okay.
Definition: status.h:83
FIFTYONE_DEGREES_STATUS_TOO_MANY_OPEN_FILES
Too many files are open.
Definition: status.h:98
FIFTYONE_DEGREES_STATUS_ENCODING_ERROR
There was an error encoding characters of a string.
Definition: status.h:118
FIFTYONE_DEGREES_STATUS_FILE_COPY_ERROR
The data file could not be copied.
Definition: status.h:107

Generated by doxygen 1.8.15