Task.Update Method

Article
12/03/2008

This method updates the old package XML with the new package XML if CanUpdate is set to true.

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

Syntax

'Declaration
Public Overridable Sub Update ( _
    ByRef ObjectXml As String _
)

public virtual void Update (
    ref string ObjectXml
)

public:
virtual void Update (
    String^% ObjectXml
)

public void Update (
    /** @ref */ String ObjectXml
)

JScript does not support passing value-type arguments by reference.

Parameters

ObjectXml
A String that contains the XML of the old object.

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