Impact Acquire SDK .NET
Public Member Functions | Static Public Member Functions | Properties | List of all members
ImpactAcquireException Class Reference
Common

An base class for exceptions generated by Impact Acquire. More...

Inheritance diagram for ImpactAcquireException:
[legend]

Public Member Functions

 ImpactAcquireException (String errorString, int errorCode)
 Constructs a new mv.impact.acquire.ImpactAcquireException object.
 

Static Public Member Functions

static String getErrorCodeAsString (int errorCode)
 Returns a string representation of a error.
 
static String getErrorCodeAsString (TDMR_ERROR errorCode)
 Returns a string representation of a error.
 
static String getErrorCodeAsString (TPROPHANDLING_ERROR errorCode)
 Returns a string representation of a error.
 

Properties

int errorCode [get]
 Returns a unique numerical representation for this error.
 
String errorCodeAsString [get]
 Returns a string representation of the error associated with the exception.
 
String errorString [get]
 Returns an error string containing information about the reason for the error.
 

Detailed Description

An base class for exceptions generated by Impact Acquire.

Examples
Callback.cs, CaptureToUserMemory.cs, ContinuousCapture.cs, ContinuousCaptureAllDevices.cs, ContinuousCaptureSimple.cs, ContinuousSaveImage.cs, DigitalIOs.cs, GenICamCallbackOnEvent.cs, GenICamCommonSettingsUsage.cs, GenICamInterfaceLayout.cs, Properties.cs, SingleCapture.cs, and SingleCaptureStorage.cs.

Constructor & Destructor Documentation

◆ ImpactAcquireException()

ImpactAcquireException ( String errorString,
int errorCode )
inline

Constructs a new mv.impact.acquire.ImpactAcquireException object.

Parameters
[in]errorStringThe string representation of the error.
[in]errorCodeThe numerical representation of the error.

Member Function Documentation

◆ getErrorCodeAsString() [1/3]

static String getErrorCodeAsString ( int errorCode)
inlinestatic

Returns a string representation of a error.

This function will return the name of the enum of the error code.

Example

In case of error -2102 this function would return mv.impact.acquire.TDMR_ERROR.DMR_DRV_ALREADY_IN_USE, which is the error codes corresponding enum name.

Parameters
[in]errorCodeThe error code to query a string representation for
Examples
CaptureToUserMemory.cs, ContinuousCapture.cs, ContinuousCaptureAllDevices.cs, ContinuousSaveImage.cs, GenICamCallbackOnEvent.cs, GenICamCommonSettingsUsage.cs, GenICamInterfaceLayout.cs, Properties.cs, SingleCapture.cs, and SingleCaptureStorage.cs.

◆ getErrorCodeAsString() [2/3]

static String getErrorCodeAsString ( TDMR_ERROR errorCode)
inlinestatic

Returns a string representation of a error.

This function will return the name of the enum of the error code.

Example

In case of error -2102 this function would return mv.impact.acquire.TDMR_ERROR.DMR_DRV_ALREADY_IN_USE, which is the error codes corresponding enum name.

Parameters
[in]errorCodeThe error code to query a string representation for

◆ getErrorCodeAsString() [3/3]

static String getErrorCodeAsString ( TPROPHANDLING_ERROR errorCode)
inlinestatic

Returns a string representation of a error.

This function will return the name of the enum of the error code.

Example

In case of error -2102 this function would return mv.impact.acquire.TDMR_ERROR.DMR_DRV_ALREADY_IN_USE, which is the error codes corresponding enum name.

Parameters
[in]errorCodeThe error code to query a string representation for

Property Documentation

◆ errorCode

int errorCode
get

Returns a unique numerical representation for this error.

Examples
ContinuousCaptureAllDevices.cs.

◆ errorCodeAsString

String errorCodeAsString
get

Returns a string representation of the error associated with the exception.

This function will return the name of the enum of the error code.

Example

In case of error -2102 this function would return mv.impact.acquire.TDMR_ERROR.DMR_DRV_ALREADY_IN_USE, which is the error codes corresponding enum name.

Examples
CaptureToUserMemory.cs, ContinuousCaptureAllDevices.cs, ContinuousSaveImage.cs, and Properties.cs.

◆ errorString

String errorString
get

Returns an error string containing information about the reason for the error.

Examples
Properties.cs.