Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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)
'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)

Parameters

strParent
Type: System.String
The name of the parent folder.
strOldName
Type: System.String
The name of the existing folder.
strNewName
Type: System.String
The new name of the 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, Nothing 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, Nothing if you use Windows Authentication.

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

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.