Click or drag to resize

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.

Inheritance Hierarchy
SystemObject
  SystemException
    ASCOMDriverException
      More...

Namespace:  ASCOM
Assembly:  ASCOM.Exceptions (in ASCOM.Exceptions.dll) Version: 3c9121baba46811fe6e53a58a05935662261416d
Syntax
[SerializableAttribute]
public class DriverException : Exception

The DriverException type exposes the following members.

Constructors
  NameDescription
Public methodDriverException
Initializes a new instance of the DriverException class that will return the 'unspecified error' number: 0x800404FF. Sets the COM HResult to UnspecifiedError.
Public methodDriverException(String)
Initializes a new instance of the DriverException class with a human-readable descriptive message.
Public methodDriverException(String, Exception)
Initializes a new instance of the DriverException class from another caught exception and a human-readable descriptinve message.
Public methodDriverException(String, Int32)
Create a new ASCOM exception using the specified text message and error code.
Public methodDriverException(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.
Top
Properties
  NameDescription
Public propertyData
Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception.)
Public propertyHelpLink
Gets or sets a link to the help file associated with this exception.
(Inherited from Exception.)
Public propertyHResult
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception.)
Public propertyInnerException
Gets the Exception instance that caused the current exception.
(Inherited from Exception.)
Public propertyMessage
Gets a message that describes the current exception.
(Inherited from Exception.)
Public propertyNumber
The COM error code for this exception (hex 80040400 - 800404FF)
Public propertySource
Gets or sets the name of the application or the object that causes the error.
(Inherited from Exception.)
Public propertyStackTrace
Gets a string representation of the immediate frames on the call stack.
(Inherited from Exception.)
Public propertyTargetSite
Gets the method that throws the current exception.
(Inherited from Exception.)
Top
Methods
  NameDescription
Public methodGetBaseException
When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception.)
Public methodGetObjectData
When overridden in a derived class, sets the SerializationInfo with information about the exception.
(Inherited from Exception.)
Public methodGetType
Gets the runtime type of the current instance.
(Inherited from Exception.)
Public methodToString
Creates and returns a string representation of the current exception.
(Inherited from Exception.)
Top
See Also
Inheritance Hierarchy