Instance.Export Method

  • Article

Creates an XML instance configuration file (ICF) and one or more XML application definition files (ADFs) (one per application) by exporting the metadata from the databases.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Sub Export ( _
    baseDirectory As String, _
    overwriteExistingFiles As Boolean _
)

public void Export (
    string baseDirectory,
    bool overwriteExistingFiles
)

public:
void Export (
    String^ baseDirectory, 
    bool overwriteExistingFiles
)

public void Export (
    String baseDirectory, 
    boolean overwriteExistingFiles
)

public function Export (
    baseDirectory : String, 
    overwriteExistingFiles : boolean
)

Parameters

  • baseDirectory
    A String that specifies the full path of the directory in which to write the files.
  • overwriteExistingFiles
    true to overwrite files of the same name in the specified directory; otherwise, false.

Remarks

The resulting files are valid definitions of the instance and applications at the time that you run the export command. You can use this information to back up your instance and application definitions or to generate files that you can use to create or update the instance.

You can export metadata while the Notification Services instance is running. There is no need to disable or stop the instance.

The resulting configuration file is named instance_name.config.xml. Each resulting ADF is named instance_name.application_name.adf.xml.

The Export method exports the files using UTF-8 encoding. To export the configuration and application definition files using other encodings, use the Export command in Microsoft SQL Server Management Studio.

Example

The following examples show how to use this method to export an ICF for an instance of Notification Services:

nsinst.Export(@"C:\NS\Full", true);

myInstance.Export("C:\NS\Full", True)

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.

See Also

Reference

Instance Class
Instance Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Exporting Notification Services Instance and Application Metadata