• Article

ComponentUpgradeFailedException Class

The exception that is thrown when the PerformUpgrade method of a component fails.

Inheritance Hierarchy

System.Object
  System.Exception
    System.ApplicationException
      Microsoft.SqlServer.Dts.Pipeline.ComponentUpgradeFailedException

Namespace:  Microsoft.SqlServer.Dts.Pipeline
Assembly:  Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public Class ComponentUpgradeFailedException _
    Inherits ApplicationException
'Usage
Dim instance As ComponentUpgradeFailedException

[SerializableAttribute]
public class ComponentUpgradeFailedException : ApplicationException

[SerializableAttribute]
public ref class ComponentUpgradeFailedException : public ApplicationException

[<SerializableAttribute>]
type ComponentUpgradeFailedException =  
    class
        inherit ApplicationException
    end

public class ComponentUpgradeFailedException extends ApplicationException

The ComponentUpgradeFailedException type exposes the following members.

Constructors

  Name Description
Public method ComponentUpgradeFailedException Initializes a new instance of the ComponentUpgradeFailedException class with the IdentificationString of the component that failed to upgrade.

Top

Properties

  Name Description
Public property Data (Inherited from Exception.)
Public property HelpLink (Inherited from Exception.)
Protected property HResult (Inherited from Exception.)
Public property InnerException (Inherited from Exception.)
Public property Message (Inherited from Exception.)
Public property Source (Inherited from Exception.)
Public property StackTrace (Inherited from Exception.)
Public property TargetSite (Inherited from Exception.)

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetBaseException (Inherited from Exception.)
Public method GetHashCode (Inherited from Object.)
Public method GetObjectData (Inherited from Exception.)
Public method GetType (Inherited from Exception.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Exception.)

Top

Remarks

When the version of a component, specified by the CurrentVersion property, that is stored in the package XML is less than the CurrentVersion property of the component on the local computer, PerformUpgrade is called. This method gives the component the opportunity to upgrade the IDTSComponentMetaData100 in the package XML to match the current version. If the component does not override the base class implementation of PerformUpgrade or if an exception occurs during the component's implementation of this method, then ComponentUpgradeFailedException is thrown.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.