artec::sdk::base::errors Namespace Reference

This namespace is auto-generated from internal event code list. More...

Enumerations

enum  ErrorCode {
  ErrorCode_OK = 0x00000000,
  ErrorCode_OsError = 0xC0000001,
  ErrorCode_FileNotFound = 0x80000002,
  ErrorCode_PathNotFound = 0x80000003,
  ErrorCode_AccessDenied = 0xC0000005,
  ErrorCode_InvalidHandle = 0xC0000006,
  ErrorCode_NotEnoughMemory = 0x80000008,
  ErrorCode_OutOfMemory = 0xC000000E,
  ErrorCode_FileExists = 0x80000050,
  ErrorCode_FilePathTooLong = 0x80000051,
  ErrorCode_FileIsDirectory = 0x80000052,
  ErrorCode_FileReadError = 0xC0000060,
  ErrorCode_FileWriteError = 0xC0000061,
  ErrorCode_ClientInterfaceStartFailed = 0xC0010001,
  ErrorCode_ClientInterfaceShutdownFailed = 0x80010004,
  ErrorCode_OperationUnsupported = 0x80010100,
  ErrorCode_OperationDenied = 0x80010101,
  ErrorCode_OperationInvalid = 0x80010102,
  ErrorCode_OperationTimeouted = 0x80010103,
  ErrorCode_OperationFailed = 0x80010104,
  ErrorCode_OperationAborted = 0x00010105,
  ErrorCode_ParameterUnsupported = 0x80010200,
  ErrorCode_ArgumentInvalid = 0x80010201,
  ErrorCode_ArgumentOutOfRange = 0x80010202,
  ErrorCode_FormatUnsupported = 0x80010300,
  ErrorCode_FormatInvalid = 0x80010301,
  ErrorCode_TestMockWarning = 0x80020002,
  ErrorCode_TestMockFailure = 0xC0020003,
  ErrorCode_InternalFailure = 0xC0030000,
  ErrorCode_DriverNotFound = 0xC0030100,
  ErrorCode_DriverVersionUnsupported = 0xC0030101,
  ErrorCode_LibNotFound = 0xC0030200,
  ErrorCode_LibVersionUnsupported = 0xC0030201,
  ErrorCode_LibInternalFailure = 0xC0030206,
  ErrorCode_LibFeatureUnsupported = 0xC0030207,
  ErrorCode_LibOperationUnsupported = 0xC0030210,
  ErrorCode_LibOperationInvalid = 0xC0030211,
  ErrorCode_LibParameterUnsupported = 0xC0030220,
  ErrorCode_LibArgumentInvalid = 0xC0030221,
  ErrorCode_LibArgumentOutOfRange = 0xC0030222,
  ErrorCode_ConfigNotFound = 0xC0030300,
  ErrorCode_ConfigVersionUnsupported = 0xC0030301,
  ErrorCode_ConfigCorrupted = 0xC0030302,
  ErrorCode_ConfigAccessFailure = 0xC0030305,
  ErrorCode_ConfigParameterNotFound = 0xC0030310,
  ErrorCode_ConfigParameterInvalid = 0xC0030311,
  ErrorCode_DevLogicFailure = 0xC0050000,
  ErrorCode_MathFailure = 0xC0050010,
  ErrorCode_UnresolvedException = 0xC0050101,
  ErrorCode_UnresolvedOsException = 0xC0050102,
  ErrorCode_UnresolvedStdException = 0xC0050103,
  ErrorCode_UnresolvedBoostException = 0xC0050104,
  ErrorCode_UnknownExceptionType = 0xC0050110,
  ErrorCode_SecondaryException = 0xC0050111,
  ErrorCode_UnmappedError = 0xC0050200,
  ErrorCode_ExpectationFailure = 0xC0050300,
  ErrorCode_OpenGlInvalidVersion = 0xC0060100,
  ErrorCode_CameraNotConnected = 0x80070101,
  ErrorCode_CameraUnsupported = 0x80070102,
  ErrorCode_CameraNotLicenced = 0x80070103,
  ErrorCode_CameraLocked = 0x80070108,
  ErrorCode_CameraInitializationFailed = 0x8007010F,
  ErrorCode_CameraNotInitialized = 0xC0070110,
  ErrorCode_CameraSettingUnsupported = 0x80070120,
  ErrorCode_CameraSettingInvalid = 0x80070121,
  ErrorCode_CameraFirmwareFailure = 0xC0070130,
  ErrorCode_CameraFirmwareAccessFailure = 0x80070140,
  ErrorCode_CameraFirmwareAccessTimeout = 0x80070141,
  ErrorCode_CameraBusy = 0xC0070150,
  ErrorCode_ScannerNotConnected = 0x80070201,
  ErrorCode_ScannerUnsupported = 0x80070202,
  ErrorCode_ScannerNotLicensed = 0x80070203,
  ErrorCode_ScannerLocked = 0x80070208,
  ErrorCode_ScannerInitializationFailed = 0x8007020F,
  ErrorCode_ScannerNotInitialized = 0xC0070210,
  ErrorCode_ScannerBusy = 0x80070250,
  ErrorCode_BundlesUnsupported = 0x80070300,
  ErrorCode_BundlesNotLicensed = 0x80070301,
  ErrorCode_BundleCalibrationFailed = 0x80070321,
  ErrorCode_BundleStagingFailure = 0x80070323,
  ErrorCode_BundleInsufficientOverlapping = 0x80070324,
  ErrorCode_BundleUncalibrated = 0xC0070330,
  ErrorCode_StrobeFailure = 0xC0070500,
  ErrorCode_TriggerFailure = 0xC0070510,
  ErrorCode_FrameCaptureTimeout = 0x80070800,
  ErrorCode_FrameCorrupted = 0x80070801,
  ErrorCode_FrameReconstructionFailed = 0x80070803,
  ErrorCode_FrameRegistrationFailed = 0x80070808
}
 

Detailed Description

This namespace is auto-generated from internal event code list.

Code

Error Code is returned as a result of any SDK function/method call. Generally any non-zero error code value is considered as failure.

There are two types of failures:

  1. Recoverable failure (warning type) - operation has failed, but no harm is done.

    It means that you can continue to use SDK and fulfill some recovery strategy. For example, you may afford to skip badly captured frames while scanning, ask user to adjust invalid parameters, or so.

    In general cases you can fix these errors yourself by referring to the error code, executing the program with the log trace on and fixing what's wrong.

    Note that frame capturing failures are 'normal' and should be ignored up to ~10%. Nevertheless, if the rate of such failures exceeds 10% it means that a scanner has 'issues' with your PC environment, like old scanner connecting to USB3 port, driver version incompatibility, etc.

  2. Critical failure (critical error type) - operation failed and SDK is unlikely to continue running without restart, some fixes are needed in your environment or in the code itself.

    There are several causes of such failures:

    • environment issues, like:
      • hardware compatibility;
      • access rights;
      • missing config files;
      • software version mismatch; and so on.
    • subscription issues
    • internal logic failures, and others.

    Most ot these failures require Artec SDK support to be contacted.

Enumeration Type Documentation

Enumerator
ErrorCode_OK 

[SUCCESS] 0x00000000: Success

ErrorCode_OsError 

[CRITICAL] 0xC0000001: Unmapped OS error

----------------------------------------------------------------——///

ErrorCode_FileNotFound 

[WARNING] 0x80000002: The OS cannot find the file specified

ErrorCode_PathNotFound 

[WARNING] 0x80000003: The OS cannot find the path specified

ErrorCode_AccessDenied 

[CRITICAL] 0xC0000005: Access to the OS resource is denied. Check for lost references, access rights, etc.

ErrorCode_InvalidHandle 

[CRITICAL] 0xC0000006: Invalid OS handle

ErrorCode_NotEnoughMemory 

[WARNING] 0x80000008: Not enough storage is available to process the operation

ErrorCode_OutOfMemory 

[CRITICAL] 0xC000000E: Not enough storage is available to complete the operation

ErrorCode_FileExists 

[WARNING] 0x80000050: The file already exists

ErrorCode_FilePathTooLong 

[WARNING] 0x80000051: The file path is too long

ErrorCode_FileIsDirectory 

[WARNING] 0x80000052: The requested file is a directory

ErrorCode_FileReadError 

[CRITICAL] 0xC0000060: The file read error (unspecified)

ErrorCode_FileWriteError 

[CRITICAL] 0xC0000061: The file write error (unspecified)

ErrorCode_ClientInterfaceStartFailed 

[CRITICAL] 0xC0010001: Client interface start failed

----------------------------------------------------------------——///

Note
These are caused by SDK's usage - external or internal. Anyway, most likely that your code does something it shouldn't.
ErrorCode_ClientInterfaceShutdownFailed 

[WARNING] 0x80010004: Client interface shutdown failed

ErrorCode_OperationUnsupported 

[WARNING] 0x80010100: Requested operation is unsupported. Check versions

ErrorCode_OperationDenied 

[WARNING] 0x80010101: Requested operation is denied. Check your license(s)

ErrorCode_OperationInvalid 

[WARNING] 0x80010102: Requested operation is invalid

ErrorCode_OperationTimeouted 

[WARNING] 0x80010103: Requested operation hasn't completed in time

ErrorCode_OperationFailed 

[WARNING] 0x80010104: Requested operation has failed

ErrorCode_OperationAborted 

[SUCCESS] 0x00010105: Requested operation was cancelled by client's side

ErrorCode_ParameterUnsupported 

[WARNING] 0x80010200: There is no such parameter. Check versions & input format

ErrorCode_ArgumentInvalid 

[WARNING] 0x80010201: Provided argument is invalid

ErrorCode_ArgumentOutOfRange 

[WARNING] 0x80010202: Provided argument is out of range

Note
Some places may still return EventCode_ArgumentInvalid instead
ErrorCode_FormatUnsupported 

[WARNING] 0x80010300: Data format is unsupported

Note
Some places may still return EventCode_ArgumentInvalid instead
ErrorCode_FormatInvalid 

[WARNING] 0x80010301: Data format is invalid

Note
Some places may still return EventCode_ArgumentInvalid instead
ErrorCode_TestMockWarning 

[WARNING] 0x80020002: Used in auto-testing to mock warning event

----------------------------------------------------------------——///

Note
Not supposed to appear in any usage case, if you still get any of these
  • please collect supportive log information and contact support with it
ErrorCode_TestMockFailure 

[CRITICAL] 0xC0020003: Used in auto-testing to mock error event

ErrorCode_InternalFailure 

[CRITICAL] 0xC0030000: Unresolved internal failure

----------------------------------------------------------------——///

Note
If you get any of these - collect supportive log information and
  • check for dependencies and their versions,
  • make sure your scanner is still registered and your SDK subscription is intact.

If everything seems OK - please contact support with collected log.

Note
STD, Boost are also considered to be a 'library', so there might be a case when an SDK developer didn't check your input parameters (as we ought to) and some of input-caused errors ended up here instead of the Client section.
ErrorCode_DriverNotFound 

[CRITICAL] 0xC0030100: Driver's not found

ErrorCode_DriverVersionUnsupported 

[CRITICAL] 0xC0030101: Driver's version is not supported

ErrorCode_LibNotFound 

[CRITICAL] 0xC0030200: Library's not found

ErrorCode_LibVersionUnsupported 

[CRITICAL] 0xC0030201: Library's version is not supported

ErrorCode_LibInternalFailure 

[CRITICAL] 0xC0030206: Library's internal failure

ErrorCode_LibFeatureUnsupported 

[CRITICAL] 0xC0030207: Used library doesn't support requested feature

ErrorCode_LibOperationUnsupported 

[CRITICAL] 0xC0030210: Used library doesn't support requested operation

ErrorCode_LibOperationInvalid 

[CRITICAL] 0xC0030211: Used library reported 'invalid operation'

ErrorCode_LibParameterUnsupported 

[CRITICAL] 0xC0030220: Used library doesn't support the parameter

ErrorCode_LibArgumentInvalid 

[CRITICAL] 0xC0030221: Used library reported 'invalid argument'

ErrorCode_LibArgumentOutOfRange 

[CRITICAL] 0xC0030222: Used library reported 'out of range argument'

ErrorCode_ConfigNotFound 

[CRITICAL] 0xC0030300: The requested config is not found. Check AIC for details

ErrorCode_ConfigVersionUnsupported 

[CRITICAL] 0xC0030301: Config version is unsupported

ErrorCode_ConfigCorrupted 

[CRITICAL] 0xC0030302: Config is corrupted

ErrorCode_ConfigAccessFailure 

[CRITICAL] 0xC0030305: Failed to access config due to parsing failure, etc.

ErrorCode_ConfigParameterNotFound 

[CRITICAL] 0xC0030310: Config parameter's not found

ErrorCode_ConfigParameterInvalid 

[CRITICAL] 0xC0030311: Config parameter's invalid

ErrorCode_DevLogicFailure 

[CRITICAL] 0xC0050000: General error for exceptions raised by developer logic faults (lost references, etc.)

----------------------------------------------------------————///

Note
Most of these exceptions are signals of developer's sloppiness. So, for most cases there is nothing you can do about except contacting support with collected log output.

Unresolved exceptions are the ones that were nor handled properly by a developer in the place of likely occurrence with more specific event code and details nor recognized by the SDK's general exception-handling procedure.

ErrorCode_MathFailure 

[CRITICAL] 0xC0050010: Division on 0, floating point math and such

ErrorCode_UnresolvedException 

Generalization for all exceptions of uncommon, but known types from 3rd-party libraries Do not confuse with EventCode_UnknownExceptionType

ErrorCode_UnresolvedOsException 

[CRITICAL] 0xC0050102: Unresolved OS exception (SEH for Windows)

ErrorCode_UnresolvedStdException 

[CRITICAL] 0xC0050103: Unresolved std::exception

ErrorCode_UnresolvedBoostException 

[CRITICAL] 0xC0050104: Unresolved boost::exception

ErrorCode_UnknownExceptionType 

[CRITICAL] 0xC0050110: Unknown exception type (caught by ...)

ErrorCode_SecondaryException 

[CRITICAL] 0xC0050111: OMG. Another exception's raised during exception handling

Note
This one is never to be returned, it can be only logged with more stable back-ends like Windows Event Log or Linux system log
ErrorCode_UnmappedError 
Note
Most likely - outdated error mapping
ErrorCode_ExpectationFailure 

[CRITICAL] 0xC0050300: Unexpected outcome (in assertions and etc.)

ErrorCode_OpenGlInvalidVersion 

[CRITICAL] 0xC0060100: OpenGL is either missing or presented by unsupported version

-------------------------------------------------------------———///

ErrorCode_CameraNotConnected 

[WARNING] 0x80070101: Requested camera is not connected

-------------------------------------------------------------———///

ErrorCode_CameraUnsupported 

[WARNING] 0x80070102: Requested camera is not supported. Check manufacturer and firmware version

ErrorCode_CameraNotLicenced 

[WARNING] 0x80070103: Requested camera is not licensed

ErrorCode_CameraLocked 

[WARNING] 0x80070108: Requested camera is already used by someone else (yet to be able diagnose)

ErrorCode_CameraInitializationFailed 

[WARNING] 0x8007010F: Camera initialization failed

ErrorCode_CameraNotInitialized 

[CRITICAL] 0xC0070110: Attempted to use uninitialized camera

ErrorCode_CameraSettingUnsupported 

[WARNING] 0x80070120: Camera setting is not supported. Check versions

ErrorCode_CameraSettingInvalid 

[WARNING] 0x80070121: Camera setting is invalid (set to invalid/unsupported value or failed to be updated to required one)

ErrorCode_CameraFirmwareFailure 

[CRITICAL] 0xC0070130: Hardware/firmware related failure on camera side

ErrorCode_CameraFirmwareAccessFailure 

[WARNING] 0x80070140: Failed on access the camera

ErrorCode_CameraFirmwareAccessTimeout 

[WARNING] 0x80070141: Timeout on access to the camera

ErrorCode_CameraBusy 

[CRITICAL] 0xC0070150: Camera is engaged with previous request

ErrorCode_ScannerNotConnected 

[WARNING] 0x80070201: Requested scanner is not connected

ErrorCode_ScannerUnsupported 

[WARNING] 0x80070202: Requested scanner is not supported. Check manufacturer and firmware version

ErrorCode_ScannerNotLicensed 

[WARNING] 0x80070203: Requested scanner is not licensed

ErrorCode_ScannerLocked 

[WARNING] 0x80070208: Requested scanner is already used by someone else (yet to be able diagnose)

ErrorCode_ScannerInitializationFailed 

[WARNING] 0x8007020F: Scanner initialization failed

ErrorCode_ScannerNotInitialized 

[CRITICAL] 0xC0070210: Attempted to use uninitialized scanner

ErrorCode_ScannerBusy 

[WARNING] 0x80070250: Scanner is engaged with previous request

ErrorCode_BundlesUnsupported 

[WARNING] 0x80070300: Current SDK version doesn't support bundles

ErrorCode_BundlesNotLicensed 

[WARNING] 0x80070301: Current SDK version is not licensed to work with bundles

ErrorCode_BundleCalibrationFailed 

[WARNING] 0x80070321: Bundle calibration failed

ErrorCode_BundleStagingFailure 

[WARNING] 0x80070323: Bundle staging failure. Bundle calibration failed due to

  • wrong calibration staging (used calibration plate, its allocation, etc.)
  • other environmental issues (missing config files, etc.)
ErrorCode_BundleInsufficientOverlapping 

[WARNING] 0x80070324: Bundle staging failure. Insufficient overlapping between scanners

ErrorCode_BundleUncalibrated 

[CRITICAL] 0xC0070330: Attempt to use uncalibrated bundle

ErrorCode_StrobeFailure 

[CRITICAL] 0xC0070500: Strobe failure

ErrorCode_TriggerFailure 

[CRITICAL] 0xC0070510: Trigger failure

ErrorCode_FrameCaptureTimeout 

[WARNING] 0x80070800: Frame capture timeout

ErrorCode_FrameCorrupted 

[WARNING] 0x80070801: Frame corrupted

ErrorCode_FrameReconstructionFailed 

[WARNING] 0x80070803: Frame reconstruction failed

ErrorCode_FrameRegistrationFailed 

[WARNING] 0x80070808: Frame registration failed

Examples:
parallel-capture-sample.cpp, scanning-and-process-sample.cpp, and simple-capture-sample.cpp.

Definition at line 58 of file Errors.h.