Impact Acquire SDK .NET
EPropertyList Class Reference

A base class for component list related exceptions from the property module. More...

Inheritance diagram for EPropertyList:
[legend]

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.
 

Package Functions

 EPropertyList (String errorString, TPROPHANDLING_ERROR errorCode)
 Creates a new mv.impact.acquire.EPropertyList object.
 

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 component list related exceptions from the property module.

This exception object will never be raised in the code. It can't be constructed directly but to check for component list related errors a catch block for mv.impact.acquire.EPropertyList objects can be written to catch all exceptions related to lists and list operations.

Constructor & Destructor Documentation

◆ EPropertyList()

EPropertyList ( String errorString,
TPROPHANDLING_ERROR errorCode )
inlinepackage

Creates a new mv.impact.acquire.EPropertyList 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.