This documentation is archived and is not being maintained.

Application.RenameFolderOnDtsServer 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)

public void RenameFolderOnDtsServer (
	string sParent,
	string sOldName,
	string sNewName,
	string sServerName
)
public void RenameFolderOnDtsServer (
	String sParent, 
	String sOldName, 
	String sNewName, 
	String sServerName
)
public function RenameFolderOnDtsServer (
	sParent : String, 
	sOldName : String, 
	sNewName : String, 
	sServerName : String
)

Parameters

sParent

The name of the parent folder.

sOldName

The name of the existing folder.

sNewName

The new name of the folder.

sServerName

The name of the server where the folder is located.

The following code example creates a folder within the Integration Services services hierarchy, verifies that the folder has been created, renames it, verifies that the old name is still recognized as a folder, and then verifies whether the new folder name is found.

static void Main(string[] args)
        {
            // Create a folder named myOldFolder.
            Application app = new Application();
            app.CreateFolderOnDtsServer(@"\File System\", "myOldFolder", "yourserver");

            // Verify that creation was successful.
            Boolean folderExists = app.FolderExistsOnDtsServer(@"File System\myOldFolder", "yourserver");
            Console.WriteLine("Folder exists? " + folderExists);

            // Rename myOldFolder to myNewFolder.
            app.RenameFolderOnDtsServer(@"File System", "myOldFolder", "myNewFolder", "yourserver");

            // Verify that the old folder still exists.
            folderExists = app.FolderExistsOnDtsServer(@"File System\myOldFolder", "yourserver");
            Console.WriteLine("Old, renamed folder exists? " + folderExists);

            // Verify that the folder exists with the new name. 
            folderExists = app.FolderExistsOnDtsServer(@"File System\myNewFolder", "yourserver");
            Console.WriteLine("New folder exists? " + folderExists);
        }

Sample Output:

Folder exists? True

Old, renamed folder exists? False

New folder exists? True

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.

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

Show: