wRTOSException Class

This class is the base class of all wRTOS exception classes.

Inheritance Hierarchy

System Object
  System Exception
    IntervalZero.MaxRT.wRTOS.wRTOSException

Namespace:  IntervalZero.MaxRT.wRTOS
Assembly:  IntervalZero.MaxRT.wRTOS (in IntervalZero.MaxRT.wRTOS .dll) Version: 1.0.0.0 (File version: 1.0.0)

Syntax

Copy
public class wRTOSException : Exception, 
    IDisposable

 

The wRTOSException type exposes the following members:

Constructors

 

Name Description

Public method

wRTOSException (String)

Constructor with a message.

Public method

wRTOSException (String, Exception)

Constructor with a message and inner exception.

Methods

 

Name Description

Public method

Dispose

Explicit dispose.

Protected method

Dispose (Boolean)

Dispose of the object.

Protected method

Finalize

Finalizer.

Public method Static member

GetCustomErrorMessage

wRTOS real-time APIs can fail with GetLastError returning a custom Win32 error code. Custom error codes have bit 29 set to mark them as application-specific error codes (per Microsoft standards). This method maps a custom Win32 error code to a human-readable message describing the error. When the wRTOS Managed library throws an exception of type Win32Exception or MaxRTNativeException (or when another type of exception has a Win32Exception object as the InnerException), you can obtain the underlying Win32 error code from property NativeErrorCode on the Win32Exception object.

Public method Static member

GetExtendedExceptionMessage

Parse an exception to give a better error message.

Public method Static member

IsCustomError

Returns true if parameter win32ErrorCode is a wRTOS custom Win32 error code, false otherwise. Use method GetCustomErrorMessage to maps a wRTOS custom error code to a human-readable error message.

Properties

 

Name Description

Protected property

IsDisposed

true if the object has been disposed.

See Also:

Inheritance Hierarchy

System Object
  System Exception
    IntervalZero.MaxRT.wRTOS.wRTOSException
      IntervalZero.MaxRT.wRTOS.wRTOSConfigReadException
      IntervalZero.MaxRT.wRTOS.wRTOSInvalidArgumentException
      IntervalZero.MaxRT.wRTOS.wRTOSInvalidEditionException
      IntervalZero.MaxRT.wRTOS.wRTOSInvalidPropertyValueException
      IntervalZero.MaxRT.wRTOS.wRTOSInvalidTcpIpStackLicense
      IntervalZero.MaxRT.wRTOS.wRTOSNotConfiguredException