Application.RemoveFolderFromSqlServer(String, String, String, String) Method

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Removes the specified folder from the specified instance of SQL Server.

public:
 void RemoveFolderFromSqlServer(System::String ^ strFolderName, System::String ^ strServerName, System::String ^ strServerUserName, System::String ^ strServerPassword);

public void RemoveFolderFromSqlServer (string strFolderName, string strServerName, string strServerUserName, string strServerPassword);

member this.RemoveFolderFromSqlServer : string * string * string * string -> unit

Public Sub RemoveFolderFromSqlServer (strFolderName As String, strServerName As String, strServerUserName As String, strServerPassword As String)

Parameters

strFolderName

String

The name of the folder to delete.

strServerName

String

The name of the instance of SQL Server to remove the folder from.

strServerUserName

String

The user name to authenticate against the instance of SQL Server.

strServerPassword

String

The password for the specified strServerUserName.

Examples

The following code example creates a folder on SQL Server, renames it, and then removes it by using RemoveFolderFromSqlServer. It also verifies the existence of the folder several times by using FolderExistsOnSqlServer.

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\100\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx";  

            Application app = new Application();  
            app.CreateFolderOnSqlServer("\\", "myNewFolder", "yourserver", null, null);  

            // Verify that the folder was created.  
            Boolean ssFolder = app.FolderExistsOnSqlServer("\\myNewFolder", "yourserver", null, null);  
            Console.WriteLine("myNewFolderExists? " + ssFolder);  

            // Rename myNewFolder to myRenamedFolder.   
            app.RenameFolderOnSqlServer("\\", "myNewFolder", "myRenamedFolder", "yourserver", null, null);  

            // Verify that the old folder does not exist.  
            ssFolder = app.FolderExistsOnSqlServer("\\myNewFolder", "yourserver", null, null);  
            Console.WriteLine("myNewFolderExists has been renamed but still exists? " + ssFolder);  

            // Verify that a folder with the new name does exist.  
            ssFolder = app.FolderExistsOnSqlServer("\\myRenamedFolder", "yourserver", null, null);  
            Console.WriteLine("myRenamedFolder now exists? " + ssFolder);  

            // Delete the folder.  
            app.RemoveFolderFromSqlServer("\\myRenamedFolder", "yourserver", null, null);  

            // Verify that the folder was removed.  
            ssFolder = app.FolderExistsOnSqlServer("\\myRenamedFolder", "yourserver", null, null);  
            Console.WriteLine("myRenamedFolder still exists? " + ssFolder);  
        }  

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\100\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx"   

            Dim app As Application =  New Application()   
            app.CreateFolderOnSqlServer("\\", "myNewFolder", "yourserver", Nothing, Nothing)  

            ' Verify that the folder was created.  
            Dim ssFolder As Boolean =  app.FolderExistsOnSqlServer("\\myNewFolder","yourserver",Nothing,Nothing)   
            Console.WriteLine("myNewFolderExists? " + ssFolder)  

            ' Rename myNewFolder to myRenamedFolder.   
            app.RenameFolderOnSqlServer("\\", "myNewFolder", "myRenamedFolder", "yourserver", Nothing, Nothing)  

            ' Verify that the old folder does not exist.  
            ssFolder = app.FolderExistsOnSqlServer("\\myNewFolder", "yourserver", Nothing, Nothing)  
            Console.WriteLine("myNewFolderExists has been renamed but still exists? " + ssFolder)  

            ' Verify that a folder with the new name does exist.  
            ssFolder = app.FolderExistsOnSqlServer("\\myRenamedFolder", "yourserver", Nothing, Nothing)  
            Console.WriteLine("myRenamedFolder now exists? " + ssFolder)  

            ' Delete the folder.  
            app.RemoveFolderFromSqlServer("\\myRenamedFolder", "yourserver", Nothing, Nothing)  

            ' Verify that the folder was removed.  
            ssFolder = app.FolderExistsOnSqlServer("\\myRenamedFolder", "yourserver", Nothing, Nothing)  
            Console.WriteLine("myRenamedFolder still exists? " + ssFolder)  
End Sub  

Sample Output:

myNewFolderExists? True

myNewFolderExists has been renamed but still exists? False

myRenamedFolder now exists? True

myRenamedFolder still exists? False