Impact Acquire SDK .NET
EPropertyHandling Class Reference

A base class for exceptions related to the property module. More...

Inheritance diagram for EPropertyHandling:
[legend]

Public Member Functions

 EPropertyHandling (String errorString, TPROPHANDLING_ERROR errorCode)
 Creates a new mv.impact.acquire.EPropertyHandling 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

A base class for exceptions related to the property module.

This exception object will only be raised if an unknown error occurred. To check for errors related to the property module a catch block for mv.impact.acquire.EPropertyHandling objects can be written to catch all property module related exceptions.

Constructor & Destructor Documentation

◆ EPropertyHandling()

EPropertyHandling ( String errorString,
TPROPHANDLING_ERROR errorCode )
inline

Creates a new mv.impact.acquire.EPropertyHandling object.

Parameters
[in]errorStringThe error string.
[in]errorCodeThe error code.

Member Function Documentation

◆ getErrorCodeAsString() [1/3]

static String getErrorCodeAsString ( int errorCode)
inlinestaticinherited

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)
inlinestaticinherited

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)
inlinestaticinherited

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
getinherited

Returns a unique numerical representation for this error.

Examples
ContinuousCaptureAllDevices.cs.

◆ errorCodeAsString

String errorCodeAsString
getinherited

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
getinherited

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

Examples
Properties.cs.