sdk_results.h File Reference

A list of SDK error/return results. More...

#include <base/inc/base_types.h>

Go to the source code of this file.

Typedefs
typedef SDKInt32	SDKResult
	Type of all error or return codes which SDK functions can end with.

Enumerations
enum	SDKErrorID { kSDKErrorID_OutOfMemory = 1, kSDKErrorID_OutOfMemory_CantAllocateTexture = 2 }
	SDK errors IDs. More...

Functions
static SDK_INLINE bool	IsSDKResultSucceeded (const SDKResult result)
	Tells if result is an error.
static SDK_INLINE bool	IsSDKResultError (const SDKResult result)
	Tells if result is an error.
static SDK_INLINE bool	IsSDKResultOK (const SDKResult result)
	Tells if result is not error.
static SDK_INLINE bool	IsSDKResultNotFound (const SDKResult result)
	Tells if result is not found or not exist.
static SDK_INLINE bool	IsSDKResultSSE (const SDKResult result)
	Tells if result is S-63 SSE result.
static SDK_INLINE bool	IsSDKResultSSEWarning (const SDKResult result)
	Tells if result is S-63 SSE warning.
static SDK_INLINE bool	IsSDKResultSSEError (const SDKResult result)
	Tells if result is S-63 SSE error.

Variables
static const SDKResult	kSDKResult_Succeeded = 0
	Operation completed successfully.
static const SDKResult	kSDKResult_True = 1
	Operation completed successfully with true result.
static const SDKResult	kSDKResult_False = 2
	Operation completed successfully with false result.
static const SDKResult	kSDKResult_EOFReached = 3
	End of file is reached.
static const SDKResult	kSDKResult_EmptyValue = 4
	Value is empty or absent.
static const SDKResult	kSDKResult_AlreadyExist = 5
	Something is exist already.
static const SDKResult	kSDKResult_Stopped = 6
	Process was stopped.
static const SDKResult	kSDKResult_Error = 0x80000000
	Error codes start point.
static const SDKResult	kSDKResult_UnexpectedError = 0x80000001
	Unexpected error occurred during operation.
static const SDKResult	kSDKResult_UnknownError = 0x80000002
	Unknown error occurred during operation.
static const SDKResult	kSDKResult_InternalError = 0x80000003
	Internal error occurred.
static const SDKResult	kSDKResult_InvalidArgument = 0x80000004
	Wrong argument passed to function.
static const SDKResult	kSDKResult_NULLPointer = 0x80000005
	NULL pointer passed to function.
static const SDKResult	kSDKResult_NotEnoughMemory = 0x80000006
	Not enough memory for an operation.
static const SDKResult	kSDKResult_NotInitialized = 0x80000007
	Not initialized.
static const SDKResult	kSDKResult_NotSupported = 0x80000008
	Not supported.
static const SDKResult	kSDKResult_NotImplemented = 0x80000009
	Not implemented.
static const SDKResult	kSDKResult_CantPerformAction = 0x80000010
	Operation can't be performed.
static const SDKResult	kSDKResult_NotFound = 0x80000011
	Something is not found.
static const SDKResult	kSDKResult_NotExist = 0x80000012
	Something does not exist.
static const SDKResult	kSDKResult_NoMoreSpace = 0x80000013
	No more free space.
static const SDKResult	kSDKResult_NotOpened = 0x80000014
	Work with not opened source.
static const SDKResult	kSDKResult_NotOpenedForRead = 0x80000015
	Reading from write-only source.
static const SDKResult	kSDKResult_NotOpenedForWrite = 0x80000016
	Writing to read-only source.
static const SDKResult	kSDKResult_NotRegistered = 0x80000017
	Something is not registered.
static const SDKResult	kSDKResult_BadFormat = 0x80000018
	Something has wrong format.
static const SDKResult	kSDKResult_BadType = 0x80000019
	Something has wrong type.
static const SDKResult	kSDKResult_CryptError = 0x80000020
	Encryption or decryption has failed.
static const SDKResult	kSDKResult_CompressionError = 0x80000021
	Compression or decompression has failed.
static const SDKResult	kSDKResult_OutOfRange = 0x80000022
	Out of range request.
static const SDKResult	kSDKResult_ReadOnly = 0x80000023
	Trying to open read-only for editing.
static const SDKResult	kSDKResult_CantLoadData = 0x80000024
	A data could not be loaded.
static const SDKResult	kSDKResult_BufferTooSmall = 0x80000025
	Buffer too small.
static const SDKResult	kSDKResult_NotApplicable = 0x80000026
	Used to indicate when information is not provided, either because it does not apply to a particular case in question or because it is not available.
static const SDKResult	kSDKResult_AlreadyInitialized = 0x80000027
	Something is already initialized.
static const SDKResult	kSDKResult_AccessDenied = 0x80000028
	Generic access denied.
static const SDKResult	kSDKResult_NotEnoughParameters = 0x80000029
	Not enough parameters.
static const SDKResult	kSDKResult_S63Error = 0x81000000
	Start point for specific S-63 errors.
static const SDKResult	kSDKResult_S63_SSE01 = 0x81000001
	SSE 01 Self Signed Key is invalid.
static const SDKResult	kSDKResult_S63_SSE02 = 0x81000002
	SSE 02 Format of Self Signed Key file is incorrect.
static const SDKResult	kSDKResult_S63_SSE03 = 0x81000003
	SSE 03 SA Signed Data Server Certificate is invalid.
static const SDKResult	kSDKResult_S63_SSE04 = 0x81000004
	SSE 04 Format of SA Signed DS Certificate is incorrect.
static const SDKResult	kSDKResult_S63_SSE05 = 0x81000005
	SSE 05 SA Digital Certificate (X509) file is not available. A valid certificate can be obtained from the IHO website or your data supplier.
static const SDKResult	kSDKResult_S63_SSE06 = 0x81000006
	SSE 06 The SA Signed Data Server Certificate is invalid. The SA may have issued a new public key or the ENC may originate from another service. A new SA public key can be obtained from the IHO website or from your data supplier.
static const SDKResult	kSDKResult_S63_SSE07 = 0x81000007
	SSE 07 SA signed DS Certificate file is not available. A valid certificate can be obtained from the IHO website or your data supplier.
static const SDKResult	kSDKResult_S63_SSE08 = 0x81000008
	SSE 08 SA Digital Certificate (X509) file incorrect format. A valid certificate can be obtained from the IHO website or your data supplier.
static const SDKResult	kSDKResult_S63_SSE09 = 0x81000009
	SSE 09 ENC Signature is invalid.
static const SDKResult	kSDKResult_S63_SSE10 = 0x81000010
	SSE 10 Permits not available for this Data Server. Contact your data supplier to obtain the correct permits.
static const SDKResult	kSDKResult_S63_SSE11 = 0x81000011
	SSE 11 Cell Permit file not found. Load the permit file provided by the data supplier.
static const SDKResult	kSDKResult_S63_SSE12 = 0x81000012
	SSE 12 Cell Permit format is incorrect. Contact your data supplier and obtain a new permit file.
static const SDKResult	kSDKResult_S63_SSE13 = 0x81000013
	SSE 13 Cell Permit is invalid (checksum is incorrect). Contact your data supplier and obtain a new permit file.
static const SDKResult	kSDKResult_S63_SSE14 = 0x81000014
	SSE 14 Incorrect system date, check that the computer clock (if accessible) is set correctly or contact your system supplier.
static const SDKResult	kSDKResult_S63_SSE15 = 0x81000015
	SSE 15 Subscription service has expired. Please contact your data supplier to renew the subscription license.
static const SDKResult	kSDKResult_S63_SSE16 = 0x81000016
	SSE 16 ENC CRC value is incorrect. Contact your data supplier as ENC(s) may be corrupted or missing data.
static const SDKResult	kSDKResult_S63_SSE17 = 0x81000017
	SSE 17 Userpermit is invalid (checksum is incorrect). Check that the correct hardware device (dongle) is connected or contact your system supplier to obtain a valid userpermit.
static const SDKResult	kSDKResult_S63_SSE18 = 0x81000018
	SSE 18 HW_ID is incorrect format.
static const SDKResult	kSDKResult_S63_SSE19 = 0x81000019
	SSE 19 Permits are not valid for this system. Contact your data supplier to obtain the correct permits.
static const SDKResult	kSDKResult_S63_SSE20 = 0x81000020
	SSE 20 Subscription service will expire in less than 30 days. Please contact your data supplier to renew the subscription license.
static const SDKResult	kSDKResult_S63_SSE21 = 0x81000021
	SSE 21 Decryption failed no valid cell permit found. Permits may be for another system or new permits may be required, please contact your supplier to obtain a new license.
static const SDKResult	kSDKResult_S63_SSE22 = 0x81000022
	SSE 22 SA Digital Certificate (X509) has expired. A new SA public key can be obtained from the IHO website or from your data supplier.
static const SDKResult	kSDKResult_S63_SSE23 = 0x81000023
	SSE 23 Non sequential update, previous update(s) missing try reloading from the base media. If the problem persists contact your data supplier.
static const SDKResult	kSDKResult_S63_SSE24 = 0x81000024
	SSE 24 ENC Signature format incorrect, contact your data supplier.
static const SDKResult	kSDKResult_S63_SSE25 = 0x81000025
	SSE 25 Viewer - The permit for ENC cell has expired. This cell may be out of date and MUST NOT be used for Primary NAVIGATION.
static const SDKResult	kSDKResult_S63_SSE26 = 0x81000026
	SSE 26 This ENC is not authenticated by the IHO acting as the Scheme Administrator.
static const SDKResult	kSDKResult_S63_SSE27 = 0x81000027
	SSE 27 Viewer - ENC cell is not up to date. A New Edition, Re-issue or Update for this cell is missing and therefore MUST NOT be used for Primary NAVIGATION.

Detailed Description

A list of SDK error/return results.

Copyright (c) 2011 The NAVTOR SDK. All Rights Reserved.

Author

The NAVTOR SDK authors

Date

08/2011

Maintenance:

The NAVTOR SDK authors