ConnectionManager.SaveToXML Method

Artykuł
12/03/2008

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

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

Syntax

'Declaration
Public Sub SaveToXML ( _
    ByRef doc As XmlDocument, _
    node As XmlNode, _
    events As IDTSEvents _
)

public void SaveToXML (
    ref XmlDocument doc,
    XmlNode node,
    IDTSEvents events
)

public:
virtual void SaveToXML (
    XmlDocument^% doc, 
    XmlNode^ node, 
    IDTSEvents^ events
) sealed

public final void SaveToXML (
    /** @ref */ XmlDocument doc, 
    XmlNode node, 
    IDTSEvents events
)

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

Parameters

doc
The XML document to which to save the connection manager information.

node
The node in the above document to which to save the information.

events
An object that implements the IDTSEvents interface for raising events (errors, warnings, and so on) during persistence.

Remarks

Updated text:5 December 2005

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 Application.SaveToXml method. If you want to save the package to the File System, use Application.SaveToDtsServer. If you want to save the package to the MSDB database, use Application.SaveToSqlServer or Application.SaveToSqlServerAs methods. When you call the 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.

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

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Udostępnij za pośrednictwem