LogProviderBase.CanUpdate Method

Article
12/03/2008

Determines whether a log provider supports upgrading the package XML to a newer version of the log provider.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Overridable Function CanUpdate ( _
    CreationName As String _
) As Boolean

public virtual bool CanUpdate (
    string CreationName
)

public:
virtual bool CanUpdate (
    String^ CreationName
)

public boolean CanUpdate (
    String CreationName
)

public function CanUpdate (
    CreationName : String
) : boolean

Parameters

CreationName
The string used to create an instance of the object.

Return Value

true if the log provider specified in the CreationName parameter is able to update its object metadata; otherwise, false. The default is false.

Remarks

You override this method in your log provider when shipping a newer version of your log provider that is capable of updating the package XML of the log provider. If you return true the runtime engine will call your Update method to update the package XML for your log provider.

For example, you deploy version A of your log provider and store some custom properties in the package XML by overriding the SaveToXml method. At a future date, you ship version B of your log provider that no longer supports this property, and instead has a newer property. When the runtime engine finds that the Version property of the log provider contained in a package is A, but the log provider installed on the computer is B, it calls this method to see if your log provider is capable of updating the package XML. If you return true, the runtime engine calls the Update method, allowing you to update the XML.

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms