• Article

Application.RenameFolderOnSqlServer Method

Renames a folder on the specified instance of SQL Server.

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

Syntax

'Declaration
Public Sub RenameFolderOnSqlServer ( _
    strParent As String, _
    strOldName As String, _
    strNewName As String, _
    strServerName As String, _
    strServerUserName As String, _
    strServerPassword As String _
)
'Usage
Dim instance As Application
Dim strParent As String
Dim strOldName As String
Dim strNewName As String
Dim strServerName As String
Dim strServerUserName As String
Dim strServerPassword As String

instance.RenameFolderOnSqlServer(strParent, _
    strOldName, strNewName, strServerName, _
    strServerUserName, strServerPassword)

public void RenameFolderOnSqlServer(
    string strParent,
    string strOldName,
    string strNewName,
    string strServerName,
    string strServerUserName,
    string strServerPassword
)

public:
void RenameFolderOnSqlServer(
    String^ strParent, 
    String^ strOldName, 
    String^ strNewName, 
    String^ strServerName, 
    String^ strServerUserName, 
    String^ strServerPassword
)

member RenameFolderOnSqlServer : 
        strParent:string * 
        strOldName:string * 
        strNewName:string * 
        strServerName:string * 
        strServerUserName:string * 
        strServerPassword:string -> unit 

public function RenameFolderOnSqlServer(
    strParent : String, 
    strOldName : String, 
    strNewName : String, 
    strServerName : String, 
    strServerUserName : String, 
    strServerPassword : String
)

Parameters

  • strOldName
    Type: System.String
    The name of the existing folder.
  • strServerName
    Type: System.String
    The name of the instance of SQL Server.
  • strServerUserName
    Type: System.String
    The SQL Server login name if you use SQL Server Authentication to log into the server; otherwise, nulla null reference (Nothing in Visual Basic) if you use Windows Authentication.
  • strServerPassword
    Type: System.String
    The SQL Server login password if you use SQL Server Authentication to log into the server; otherwise, nulla null reference (Nothing in Visual Basic) if you use Windows Authentication.

Examples

The following code example creates a folder on SQL Server, renames it, and then removes it.

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 the 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 new 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 the 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 new 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