Task.CanUpdate Method

Article
12/03/2008

A Boolean that indicates whether the new package XML can update the old package XML.

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
A String that contains the unique identifier of the old package.

Return Value

A Boolean that indicates whether the new package XML can update the old XML.

Remarks

The run-time engine calls CanUpdate on new objects, passing in the GUID of the old object. If the new object can update the old object, the old object is passed to the new one through the Update method, where the XML is changed.

By default, all extensible objects implement CanUpdate to return false, and implement the Update method to do nothing on the XML it is given in its parameters.

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