NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
sdk_results.h
Go to the documentation of this file.
1 #ifndef SDK_SDK_RESULTS_H_
11 #define SDK_SDK_RESULTS_H_
12 
13 #include <base/inc/base_types.h>
14 
17 typedef SDKInt32 SDKResult;
18 
23 
25 static const SDKResult kSDKResult_True = 1;
26 
28 static const SDKResult kSDKResult_False = 2;
29 
32 
35 
38 
40 static const SDKResult kSDKResult_Stopped = 6;
41 
43 static const SDKResult kSDKResult_Error = 0x80000000;
44 
46 static const SDKResult kSDKResult_UnexpectedError = 0x80000001;
47 
49 static const SDKResult kSDKResult_UnknownError = 0x80000002;
50 
52 static const SDKResult kSDKResult_InternalError = 0x80000003;
53 
55 static const SDKResult kSDKResult_InvalidArgument = 0x80000004;
56 
58 static const SDKResult kSDKResult_NULLPointer = 0x80000005;
59 
61 static const SDKResult kSDKResult_NotEnoughMemory = 0x80000006;
62 
64 static const SDKResult kSDKResult_NotInitialized = 0x80000007;
65 
67 static const SDKResult kSDKResult_NotSupported = 0x80000008;
68 
70 static const SDKResult kSDKResult_NotImplemented = 0x80000009;
71 
73 static const SDKResult kSDKResult_CantPerformAction = 0x80000010;
74 
76 static const SDKResult kSDKResult_NotFound = 0x80000011;
77 
79 static const SDKResult kSDKResult_NotExist = 0x80000012;
80 
82 static const SDKResult kSDKResult_NoMoreSpace = 0x80000013;
83 
85 static const SDKResult kSDKResult_NotOpened = 0x80000014;
86 
88 static const SDKResult kSDKResult_NotOpenedForRead = 0x80000015;
89 
91 static const SDKResult kSDKResult_NotOpenedForWrite = 0x80000016;
92 
94 static const SDKResult kSDKResult_NotRegistered = 0x80000017;
95 
97 static const SDKResult kSDKResult_BadFormat = 0x80000018;
98 
100 static const SDKResult kSDKResult_BadType = 0x80000019;
101 
103 static const SDKResult kSDKResult_CryptError = 0x80000020;
104 
106 static const SDKResult kSDKResult_CompressionError = 0x80000021;
107 
109 static const SDKResult kSDKResult_OutOfRange = 0x80000022;
110 
112 static const SDKResult kSDKResult_ReadOnly = 0x80000023;
113 
115 static const SDKResult kSDKResult_CantLoadData = 0x80000024;
116 
118 static const SDKResult kSDKResult_BufferTooSmall = 0x80000025;
119 
123 static const SDKResult kSDKResult_NotApplicable = 0x80000026;
124 
126 static const SDKResult kSDKResult_AlreadyInitialized = 0x80000027;
127 
129 static const SDKResult kSDKResult_AccessDenied = 0x80000028;
130 
132 static const SDKResult kSDKResult_NotEnoughParameters = 0x80000029;
133 //------------------------------------------------------------------------------
134 
136 static const SDKResult kSDKResult_S63Error = 0x81000000;
137 
139 static const SDKResult kSDKResult_S63_SSE01 = 0x81000001;
140 
142 static const SDKResult kSDKResult_S63_SSE02 = 0x81000002;
143 
145 static const SDKResult kSDKResult_S63_SSE03 = 0x81000003;
146 
148 static const SDKResult kSDKResult_S63_SSE04 = 0x81000004;
149 
153 static const SDKResult kSDKResult_S63_SSE05 = 0x81000005;
154 
160 static const SDKResult kSDKResult_S63_SSE06 = 0x81000006;
161 
165 static const SDKResult kSDKResult_S63_SSE07 = 0x81000007;
166 
170 static const SDKResult kSDKResult_S63_SSE08 = 0x81000008;
171 
173 static const SDKResult kSDKResult_S63_SSE09 = 0x81000009;
174 
177 static const SDKResult kSDKResult_S63_SSE10 = 0x81000010;
178 
181 static const SDKResult kSDKResult_S63_SSE11 = 0x81000011;
182 
185 static const SDKResult kSDKResult_S63_SSE12 = 0x81000012;
186 
189 static const SDKResult kSDKResult_S63_SSE13 = 0x81000013;
190 
193 static const SDKResult kSDKResult_S63_SSE14 = 0x81000014;
194 
197 static const SDKResult kSDKResult_S63_SSE15 = 0x81000015;
198 
201 static const SDKResult kSDKResult_S63_SSE16 = 0x81000016;
202 
206 static const SDKResult kSDKResult_S63_SSE17 = 0x81000017;
207 
209 static const SDKResult kSDKResult_S63_SSE18 = 0x81000018;
210 
213 static const SDKResult kSDKResult_S63_SSE19 = 0x81000019;
214 
217 static const SDKResult kSDKResult_S63_SSE20 = 0x81000020;
218 
222 static const SDKResult kSDKResult_S63_SSE21 = 0x81000021;
223 
226 static const SDKResult kSDKResult_S63_SSE22 = 0x81000022;
227 
230 static const SDKResult kSDKResult_S63_SSE23 = 0x81000023;
231 
233 static const SDKResult kSDKResult_S63_SSE24 = 0x81000024;
234 
237 static const SDKResult kSDKResult_S63_SSE25 = 0x81000025;
238 
240 static const SDKResult kSDKResult_S63_SSE26 = 0x81000026;
241 
245 static const SDKResult kSDKResult_S63_SSE27 = 0x81000027;
247 
251 static SDK_INLINE bool IsSDKResultSucceeded(const SDKResult result) { return (result == kSDKResult_Succeeded); }
253 static SDK_INLINE bool IsSDKResultError(const SDKResult result) { return (result & kSDKResult_Error) != 0; }
255 static SDK_INLINE bool IsSDKResultOK(const SDKResult result) { return !IsSDKResultError(result); }
257 static SDK_INLINE bool IsSDKResultNotFound(const SDKResult result) { return ((result == kSDKResult_NotFound) || (result == kSDKResult_NotExist)); }
258 
260 static SDK_INLINE bool IsSDKResultSSE(const SDKResult result) { return 0 != (result & 0x01000000); }
262 static SDK_INLINE bool IsSDKResultSSEWarning(const SDKResult result)
263 {
264  if (!IsSDKResultSSE(result))
265  return false;
266 
267  if (kSDKResult_S63_SSE15 == result ||
268  kSDKResult_S63_SSE20 == result ||
269  kSDKResult_S63_SSE25 == result ||
270  kSDKResult_S63_SSE26 == result ||
271  kSDKResult_S63_SSE27 == result)
272  return true;
273 
274  return false;
275 }
277 static SDK_INLINE bool IsSDKResultSSEError(const SDKResult result)
278 {
279  if (!IsSDKResultSSE(result))
280  return false;
281  return !IsSDKResultSSEWarning(result);
282 }
284 
289 {
292 };
294 
295 #endif // SDK_SDK_RESULTS_H_
kSDKResult_S63_SSE13
static const SDKResult kSDKResult_S63_SSE13
SSE 13 Cell Permit is invalid (checksum is incorrect). Contact your data supplier and obtain a new pe...
Definition: sdk_results.h:189
kSDKResult_S63_SSE10
static const SDKResult kSDKResult_S63_SSE10
SSE 10 Permits not available for this Data Server. Contact your data supplier to obtain the correct p...
Definition: sdk_results.h:177
IsSDKResultSSEError
static SDK_INLINE bool IsSDKResultSSEError(const SDKResult result)
Tells if result is S-63 SSE error.
Definition: sdk_results.h:277
kSDKErrorID_OutOfMemory
@ kSDKErrorID_OutOfMemory
Tells that general out of memory error has occurred.
Definition: sdk_results.h:290
kSDKResult_NotEnoughParameters
static const SDKResult kSDKResult_NotEnoughParameters
Not enough parameters.
Definition: sdk_results.h:132
kSDKResult_UnexpectedError
static const SDKResult kSDKResult_UnexpectedError
Unexpected error occurred during operation.
Definition: sdk_results.h:46
kSDKResult_S63_SSE16
static const SDKResult kSDKResult_S63_SSE16
SSE 16 ENC CRC value is incorrect. Contact your data supplier as ENC(s) may be corrupted or missing d...
Definition: sdk_results.h:201
kSDKResult_S63_SSE08
static const SDKResult kSDKResult_S63_SSE08
SSE 08 SA Digital Certificate (X509) file incorrect format. A valid certificate can be obtained from ...
Definition: sdk_results.h:170
kSDKResult_S63_SSE17
static const SDKResult kSDKResult_S63_SSE17
SSE 17 Userpermit is invalid (checksum is incorrect). Check that the correct hardware device (dongle)...
Definition: sdk_results.h:206
kSDKResult_BadType
static const SDKResult kSDKResult_BadType
Something has wrong type.
Definition: sdk_results.h:100
base_types.h
SDK base types.
kSDKResult_AccessDenied
static const SDKResult kSDKResult_AccessDenied
Generic access denied.
Definition: sdk_results.h:129
kSDKResult_Error
static const SDKResult kSDKResult_Error
Error codes start point.
Definition: sdk_results.h:43
kSDKResult_S63_SSE02
static const SDKResult kSDKResult_S63_SSE02
SSE 02 Format of Self Signed Key file is incorrect.
Definition: sdk_results.h:142
kSDKResult_Stopped
static const SDKResult kSDKResult_Stopped
Process was stopped.
Definition: sdk_results.h:40
kSDKResult_S63_SSE23
static const SDKResult kSDKResult_S63_SSE23
SSE 23 Non sequential update, previous update(s) missing try reloading from the base media....
Definition: sdk_results.h:230
kSDKResult_AlreadyInitialized
static const SDKResult kSDKResult_AlreadyInitialized
Something is already initialized.
Definition: sdk_results.h:126
kSDKResult_S63_SSE26
static const SDKResult kSDKResult_S63_SSE26
SSE 26 This ENC is not authenticated by the IHO acting as the Scheme Administrator.
Definition: sdk_results.h:240
kSDKResult_NotEnoughMemory
static const SDKResult kSDKResult_NotEnoughMemory
Not enough memory for an operation.
Definition: sdk_results.h:61
IsSDKResultError
static SDK_INLINE bool IsSDKResultError(const SDKResult result)
Tells if result is an error.
Definition: sdk_results.h:253
kSDKResult_S63_SSE05
static const SDKResult kSDKResult_S63_SSE05
SSE 05 SA Digital Certificate (X509) file is not available. A valid certificate can be obtained from ...
Definition: sdk_results.h:153
kSDKResult_S63_SSE18
static const SDKResult kSDKResult_S63_SSE18
SSE 18 HW_ID is incorrect format.
Definition: sdk_results.h:209
kSDKResult_InternalError
static const SDKResult kSDKResult_InternalError
Internal error occurred.
Definition: sdk_results.h:52
kSDKResult_Succeeded
static const SDKResult kSDKResult_Succeeded
Operation completed successfully.
Definition: sdk_results.h:22
kSDKResult_S63_SSE27
static const SDKResult kSDKResult_S63_SSE27
SSE 27 Viewer - ENC cell is not up to date. A New Edition, Re-issue or Update for this cell is missin...
Definition: sdk_results.h:245
kSDKResult_S63_SSE20
static const SDKResult kSDKResult_S63_SSE20
SSE 20 Subscription service will expire in less than 30 days. Please contact your data supplier to re...
Definition: sdk_results.h:217
kSDKResult_S63_SSE09
static const SDKResult kSDKResult_S63_SSE09
SSE 09 ENC Signature is invalid.
Definition: sdk_results.h:173
kSDKResult_CantLoadData
static const SDKResult kSDKResult_CantLoadData
A data could not be loaded.
Definition: sdk_results.h:115
kSDKResult_EmptyValue
static const SDKResult kSDKResult_EmptyValue
Value is empty or absent.
Definition: sdk_results.h:34
kSDKResult_S63Error
static const SDKResult kSDKResult_S63Error
Start point for specific S-63 errors.
Definition: sdk_results.h:136
kSDKResult_NotSupported
static const SDKResult kSDKResult_NotSupported
Not supported.
Definition: sdk_results.h:67
IsSDKResultNotFound
static SDK_INLINE bool IsSDKResultNotFound(const SDKResult result)
Tells if result is not found or not exist.
Definition: sdk_results.h:257
IsSDKResultOK
static SDK_INLINE bool IsSDKResultOK(const SDKResult result)
Tells if result is not error.
Definition: sdk_results.h:255
IsSDKResultSSEWarning
static SDK_INLINE bool IsSDKResultSSEWarning(const SDKResult result)
Tells if result is S-63 SSE warning.
Definition: sdk_results.h:262
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
kSDKResult_S63_SSE07
static const SDKResult kSDKResult_S63_SSE07
SSE 07 SA signed DS Certificate file is not available. A valid certificate can be obtained from the I...
Definition: sdk_results.h:165
kSDKResult_NotRegistered
static const SDKResult kSDKResult_NotRegistered
Something is not registered.
Definition: sdk_results.h:94
kSDKResult_NotOpenedForRead
static const SDKResult kSDKResult_NotOpenedForRead
Reading from write-only source.
Definition: sdk_results.h:88
kSDKResult_UnknownError
static const SDKResult kSDKResult_UnknownError
Unknown error occurred during operation.
Definition: sdk_results.h:49
kSDKResult_S63_SSE19
static const SDKResult kSDKResult_S63_SSE19
SSE 19 Permits are not valid for this system. Contact your data supplier to obtain the correct permit...
Definition: sdk_results.h:213
kSDKResult_NotOpened
static const SDKResult kSDKResult_NotOpened
Work with not opened source.
Definition: sdk_results.h:85
kSDKResult_S63_SSE03
static const SDKResult kSDKResult_S63_SSE03
SSE 03 SA Signed Data Server Certificate is invalid.
Definition: sdk_results.h:145
kSDKResult_EOFReached
static const SDKResult kSDKResult_EOFReached
End of file is reached.
Definition: sdk_results.h:31
kSDKResult_ReadOnly
static const SDKResult kSDKResult_ReadOnly
Trying to open read-only for editing.
Definition: sdk_results.h:112
kSDKResult_NotInitialized
static const SDKResult kSDKResult_NotInitialized
Not initialized.
Definition: sdk_results.h:64
kSDKResult_S63_SSE22
static const SDKResult kSDKResult_S63_SSE22
SSE 22 SA Digital Certificate (X509) has expired. A new SA public key can be obtained from the IHO we...
Definition: sdk_results.h:226
kSDKResult_NotApplicable
static const SDKResult kSDKResult_NotApplicable
Used to indicate when information is not provided, either because it does not apply to a particular c...
Definition: sdk_results.h:123
kSDKErrorID_OutOfMemory_CantAllocateTexture
@ kSDKErrorID_OutOfMemory_CantAllocateTexture
Tells that there is not enough memory to allocate texture.
Definition: sdk_results.h:291
kSDKResult_S63_SSE11
static const SDKResult kSDKResult_S63_SSE11
SSE 11 Cell Permit file not found. Load the permit file provided by the data supplier.
Definition: sdk_results.h:181
kSDKResult_CantPerformAction
static const SDKResult kSDKResult_CantPerformAction
Operation can't be performed.
Definition: sdk_results.h:73
kSDKResult_S63_SSE25
static const SDKResult kSDKResult_S63_SSE25
SSE 25 Viewer - The permit for ENC cell has expired. This cell may be out of date and MUST NOT be use...
Definition: sdk_results.h:237
SDKErrorID
SDKErrorID
SDK errors IDs.
Definition: sdk_results.h:288
kSDKResult_OutOfRange
static const SDKResult kSDKResult_OutOfRange
Out of range request.
Definition: sdk_results.h:109
IsSDKResultSucceeded
static SDK_INLINE bool IsSDKResultSucceeded(const SDKResult result)
Tells if result is an error.
Definition: sdk_results.h:251
kSDKResult_NotOpenedForWrite
static const SDKResult kSDKResult_NotOpenedForWrite
Writing to read-only source.
Definition: sdk_results.h:91
kSDKResult_S63_SSE21
static const SDKResult kSDKResult_S63_SSE21
SSE 21 Decryption failed no valid cell permit found. Permits may be for another system or new permits...
Definition: sdk_results.h:222
kSDKResult_NotFound
static const SDKResult kSDKResult_NotFound
Something is not found.
Definition: sdk_results.h:76
kSDKResult_CompressionError
static const SDKResult kSDKResult_CompressionError
Compression or decompression has failed.
Definition: sdk_results.h:106
kSDKResult_S63_SSE01
static const SDKResult kSDKResult_S63_SSE01
SSE 01 Self Signed Key is invalid.
Definition: sdk_results.h:139
kSDKResult_AlreadyExist
static const SDKResult kSDKResult_AlreadyExist
Something is exist already.
Definition: sdk_results.h:37
kSDKResult_CryptError
static const SDKResult kSDKResult_CryptError
Encryption or decryption has failed.
Definition: sdk_results.h:103
kSDKResult_S63_SSE04
static const SDKResult kSDKResult_S63_SSE04
SSE 04 Format of SA Signed DS Certificate is incorrect.
Definition: sdk_results.h:148
kSDKResult_BadFormat
static const SDKResult kSDKResult_BadFormat
Something has wrong format.
Definition: sdk_results.h:97
kSDKResult_NotExist
static const SDKResult kSDKResult_NotExist
Something does not exist.
Definition: sdk_results.h:79
kSDKResult_True
static const SDKResult kSDKResult_True
Operation completed successfully with true result.
Definition: sdk_results.h:25
kSDKResult_NotImplemented
static const SDKResult kSDKResult_NotImplemented
Not implemented.
Definition: sdk_results.h:70
kSDKResult_S63_SSE06
static const SDKResult kSDKResult_S63_SSE06
SSE 06 The SA Signed Data Server Certificate is invalid. The SA may have issued a new public key or t...
Definition: sdk_results.h:160
kSDKResult_S63_SSE14
static const SDKResult kSDKResult_S63_SSE14
SSE 14 Incorrect system date, check that the computer clock (if accessible) is set correctly or conta...
Definition: sdk_results.h:193
kSDKResult_NoMoreSpace
static const SDKResult kSDKResult_NoMoreSpace
No more free space.
Definition: sdk_results.h:82
kSDKResult_InvalidArgument
static const SDKResult kSDKResult_InvalidArgument
Wrong argument passed to function.
Definition: sdk_results.h:55
kSDKResult_NULLPointer
static const SDKResult kSDKResult_NULLPointer
NULL pointer passed to function.
Definition: sdk_results.h:58
kSDKResult_S63_SSE12
static const SDKResult kSDKResult_S63_SSE12
SSE 12 Cell Permit format is incorrect. Contact your data supplier and obtain a new permit file.
Definition: sdk_results.h:185
IsSDKResultSSE
static SDK_INLINE bool IsSDKResultSSE(const SDKResult result)
Tells if result is S-63 SSE result.
Definition: sdk_results.h:260
kSDKResult_False
static const SDKResult kSDKResult_False
Operation completed successfully with false result.
Definition: sdk_results.h:28
kSDKResult_S63_SSE24
static const SDKResult kSDKResult_S63_SSE24
SSE 24 ENC Signature format incorrect, contact your data supplier.
Definition: sdk_results.h:233
kSDKResult_BufferTooSmall
static const SDKResult kSDKResult_BufferTooSmall
Buffer too small.
Definition: sdk_results.h:118
kSDKResult_S63_SSE15
static const SDKResult kSDKResult_S63_SSE15
SSE 15 Subscription service has expired. Please contact your data supplier to renew the subscription ...
Definition: sdk_results.h:197