Share via

  • Article

ComponentUpgradeFailedException Class

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

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

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.

Inheritance Hierarchy

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

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.