DriverException Class

This is the generic driver exception. Drivers are permitted to directly throw this exception as well as any derived exceptions. Note that the Message property is a member of Exception, the base class of DriverException. The HResult property of Exception is simply renamed to Number.

This exception should only be thrown if there is no other more appropriate exception already defined, e.g. PropertyNotImplemented, InvalidOperationException, InvalidValueException, NotConnectedException etc. These specific exceptions should be thrown where appropriate rather than using the more generic DriverException. Conform will not accept DriverExceptions where more appropriate exceptions are already defined.

As good programming practice, the Message property should not be empty, so that users understand why the exception was thrown.

Definition

Namespace: ASCOM
Assembly: ASCOM.Exceptions (in ASCOM.Exceptions.dll) Version: 6.0.0.0 (7.0.9999.9999)
C#
[SerializableAttribute]
public class DriverException : Exception
Inheritance
Object    Exception    DriverException
Derived

Constructors

DriverException Initializes a new instance of the DriverException class that will return the 'unspecified error' number: 0x800404FF. Sets the COM HResult to UnspecifiedError.
DriverException(String) Initializes a new instance of the DriverException class with a human-readable descriptive message.
DriverException(String, Exception) Initializes a new instance of the DriverException class from another caught exception and a human-readable descriptinve message.
DriverException(String, Int32) Create a new ASCOM exception using the specified text message and error code.
DriverException(String, Int32, Exception) Create a new ASCOM exception based on another exception plus additional descriptive text and error code. This member is required for a well-behaved exception class. For example, if a driver receives an exception (perhaps a COMException) from some other component yet it wants to report some meaningful error that resulted from the other error, it can package the original error in the InnerException member of the exception it generates.

Properties

DataGets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception)
HelpLinkGets or sets a link to the help file associated with this exception.
(Inherited from Exception)
HResultGets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception)
InnerExceptionGets the Exception instance that caused the current exception.
(Inherited from Exception)
MessageGets a message that describes the current exception.
(Inherited from Exception)
Number The COM error code for this exception (hex 80040400 - 800404FF)
SourceGets or sets the name of the application or the object that causes the error.
(Inherited from Exception)
StackTraceGets a string representation of the immediate frames on the call stack.
(Inherited from Exception)
TargetSiteGets the method that throws the current exception.
(Inherited from Exception)

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetBaseExceptionWhen overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the runtime type of the current instance.
(Inherited from Exception)
ToStringCreates and returns a string representation of the current exception.
(Inherited from Exception)

Extension Methods

ErrorCode Extension method to get the Alpaca Error Code for an Exception. Returns UnspecifiedError if it cannot find a better code
(Defined by ExceptionHelpers)

Version Information

.NET

Supported in: .NET 8.0 and later

.NET Standard

Supported in: 2.0

See Also