LogProviderBase.CanUpdate Method
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
'Usage
Dim instance As LogProviderBase
Dim CreationName As String
Dim returnValue As Boolean
returnValue = instance.CanUpdate(CreationName)
public virtual bool CanUpdate(
string CreationName
)
public:
virtual bool CanUpdate(
String^ CreationName
)
abstract CanUpdate :
CreationName:string -> bool
override CanUpdate :
CreationName:string -> bool
public function CanUpdate(
CreationName : String
) : boolean
Parameters
- CreationName
Type: System.String
The string used to create an instance of the object.
Return Value
Type: System.Boolean
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.