ScriptTask.LoadFromXML Method
Implements loading of properties from XML document.
Namespace: Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly: Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)
Syntax
'Declaration
Public Sub LoadFromXML ( _
elemProj As XmlElement, _
events As IDTSInfoEvents _
)
'Usage
Dim instance As ScriptTask
Dim elemProj As XmlElement
Dim events As IDTSInfoEvents
instance.LoadFromXML(elemProj, events)
public void LoadFromXML(
XmlElement elemProj,
IDTSInfoEvents events
)
public:
virtual void LoadFromXML(
XmlElement^ elemProj,
IDTSInfoEvents^ events
) sealed
abstract LoadFromXML :
elemProj:XmlElement *
events:IDTSInfoEvents -> unit
override LoadFromXML :
elemProj:XmlElement *
events:IDTSInfoEvents -> unit
public final function LoadFromXML(
elemProj : XmlElement,
events : IDTSInfoEvents
)
Parameters
- elemProj
Type: System.Xml.XmlElement
The XML element to load from.
- events
Type: Microsoft.SqlServer.Dts.Runtime.IDTSInfoEvents
An interface for raising events (errors, warnings, and so on) during persistence.
Implements
IDTSComponentPersist.LoadFromXML(XmlElement, IDTSInfoEvents)
Remarks
This method, LoadFromXML, is available because it is public on an interface that you inherit when you are creating custom objects and by objects shipped in the SSIS runtime. This method is intended for inheritance only and should not be called from code for other purposes. If you are creating a custom object and need information about how to write your own LoadFromXML method, see Extending Packages with Custom Objects.
If you want to load a package that has been saved as XML, use the Application.LoadPackage method. If the package has been saved to the File System or MSDB database, use the Application.LoadFromSqlServer or Application.LoadFromDtsServer methods.
When you call any of the loading methods on the Application, the runtime will iterate through the tasks, connection managers, log providers, and all other objects that are contained by the package and call the LoadFromXML method on each of them. The contained objects have code in their LoadFromXML that parses the XmlElement for each property that the object must recreate, and the value saved for the element. Therefore, you do not directly call the LoadFromXML on the individual objects, but call the method on the Application object, and the runtime will cascade through the package and call the LoadFromXML on the objects for you.