Share via


ForEachEnumerator.Update Method

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 _
)
'Usage
Dim instance As ForEachEnumerator 
Dim ObjectXml As String

instance.Update(ObjectXml)
public virtual void Update(
    ref string ObjectXml
)
public:
virtual void Update(
    String^% ObjectXml
)
abstract Update : 
        ObjectXml:string byref -> unit  
override Update : 
        ObjectXml:string byref -> unit
public function Update(
    ObjectXml : String
)

Parameters

  • ObjectXml
    Type: System.String%
    A string that contains the XML of the old object.

Remarks

The runtime calls CanUpdate on new objects and passes 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.

See Also

Reference

ForEachEnumerator Class

Microsoft.SqlServer.Dts.Runtime Namespace