Variable.SaveToXML(XmlDocument, XmlNode, IDTSEvents) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This method is not callable by your application code. Saves a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.
public:
virtual void SaveToXML(System::Xml::XmlDocument ^ % doc, System::Xml::XmlNode ^ node, Microsoft::SqlServer::Dts::Runtime::IDTSEvents ^ events);public void SaveToXML (ref System.Xml.XmlDocument doc, System.Xml.XmlNode node, Microsoft.SqlServer.Dts.Runtime.IDTSEvents events);abstract member SaveToXML : XmlDocument * System.Xml.XmlNode * Microsoft.SqlServer.Dts.Runtime.IDTSEvents -> unit
override this.SaveToXML : XmlDocument * System.Xml.XmlNode * Microsoft.SqlServer.Dts.Runtime.IDTSEvents -> unitPublic Sub SaveToXML (ByRef doc As XmlDocument, node As XmlNode, events As IDTSEvents)Parameters
- doc
- XmlDocument
The XML document to which to save the information.
- node
- XmlNode
The node within the above document to which to save the information.
- events
- IDTSEvents
An IDTSEvents interface.
Implements
Remarks
This method, SaveToXML 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 SaveToXML method, see Extending Packages with Custom Objects.
If you want to save a package as XML, use the Microsoft.SqlServer.Dts.Runtime.Application.SaveToXml method. If you want to save the package to the File System, use Microsoft.SqlServer.Dts.Runtime.Application.SaveToDtsServer. If you want to save the package to the MSDB database, use Microsoft.SqlServer.Dts.Runtime.Application.SaveToSqlServer or Microsoft.SqlServer.Dts.Runtime.Application.SaveToSqlServerAs methods. When you call the Microsoft.SqlServer.Dts.Runtime.Application.SaveToXml 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 SaveToXML method on each of them. The contained objects have code in their SaveToXML that creates an XmlElement for each property that the object must save, and a value for the element. The package contains the XmlDocument and the objects append their specific elements into the package’s XmlDocument. Therefore, you do not directly call the SaveToXML on the individual objects, but call the method on the Application object, and the runtime will cascade through the package objects and call the SaveToXML for you.