Application.SaveToXml Method

Article
12/03/2008

Saves the XML definition of a package to a file.

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

Syntax

'Declaration
Public Sub SaveToXml ( _
    fileName As String, _
    package As Package, _
    events As IDTSEvents _
)

public void SaveToXml (
    string fileName,
    Package package,
    IDTSEvents events
)

public:
void SaveToXml (
    String^ fileName, 
    Package^ package, 
    IDTSEvents^ events
)

public void SaveToXml (
    String fileName, 
    Package package, 
    IDTSEvents events
)

public function SaveToXml (
    fileName : String, 
    package : Package, 
    events : IDTSEvents
)

Parameters

fileName
The name of the file to save.

package
The package object to save.

events
An IDTSEvents object.

Remarks

A package file normally has the extension .dtsx.

If the file name specified in the fileName parameter does not exist, it will be created.

Example

The following example saves the .dtsx package in XML format with the name myXMLPackage.dtsx.

static void Main(string[] args)
        {
            // The variable pkg points to the location
            // of the ExecuteProcess package sample 
            // that is installed with the SSIS samples.
            string pkg = @"C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx";

            Application app = new Application();
            Package p = app.LoadPackage(pkg, null);
            app.SaveToXml("myXMLPackage.dtsx", p, null);
        }

Shared  Sub Main(ByVal args() As String)
            ' The variable pkg points to the location
            ' of the ExecuteProcess package sample 
            ' that is installed with the SSIS samples.
            Dim pkg As String =  "C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx" 
 
            Dim app As Application =  New Application() 
            Dim p As Package =  app.LoadPackage(pkg,Nothing) 
            app.SaveToXml("myXMLPackage.dtsx", p, Nothing)
End Sub

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