COMCapeOpenExceptionWrapper Class

A wrapper class for COM-based exceptions.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
[SerializableAttribute]
[ComVisibleAttribute(true)]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[GuidAttribute("31CD55DE-AEFD-44ff-8BAB-F6252DD43F16")]
public class COMCapeOpenExceptionWrapper : CapeUserException
Inheritance
Object    Exception    ApplicationException    CapeUserException    COMCapeOpenExceptionWrapper

Remarks

This class can be used when a COM-based CAPE-OPEN component returns a failure HRESULT. A failure HRESULT indicates an error condition has occurred. This class is used by the to rethrow the COM-based error condition as a .Net-based exception.

The CAPE-OPEN error handling process chose not to use the COM IErrorInfo API due to limitation of the Visual Basic programming language at the time that the error handling protocols were developed. Instead, the CAPE-OPEN error handling protocol requires that component in which the error occurs expose the appropriate error interfaces. In practice, this typically means that all CAPE-OPEN objects implement the , , and sometimes the error interfaces.

This class wraps the CAPE-OPEN object that threw the exception and creates the appropriate .Net exception so users can use the .Net exception handling protocols.

Constructors

COMCapeOpenExceptionWrapper Creates a new instance of the COMCapeOpenExceptionWrapper class.

Properties

code Code to designate the subcategory of the error.
(Inherited from CapeUserException)
description The description of the error.
(Inherited from CapeUserException)
interfaceName The name of the interface where the error is thrown. This is a mandatory field."
(Inherited from CapeUserException)
moreInfo An URL to a page, document, web site, where more information on the error can be found. The content of this information is obviously implementation dependent.
(Inherited from CapeUserException)
Name The name of the exception being thrown.
(Inherited from CapeUserException)
operation The name of the operation where the error is thrown. This is a mandatory field.
(Inherited from CapeUserException)
scope The scope of the error.
(Inherited from CapeUserException)

Methods

Initialize Initializes the description, interface name and name fields of this exception.
(Overrides CapeUserExceptionInitialize)

Fields

m_description The description of the exception being thrown.
(Inherited from CapeUserException)
m_interfaceName The name of the exception interface for the exception being thrown.
(Inherited from CapeUserException)
m_name The name of the exception being thrown.
(Inherited from CapeUserException)

Extension Methods

GetEnumNames
(Defined by General)
IsValidDouble
(Defined by General)

See Also