Application.FolderExistsOnSqlServer(String, String, String, String) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a Boolean that indicates whether the specified folder already exists on the instance of SQL Server.

public:
 bool FolderExistsOnSqlServer(System::String ^ strFolderName, System::String ^ strServerName, System::String ^ strServerUserName, System::String ^ strServerPassword);

public bool FolderExistsOnSqlServer (string strFolderName, string strServerName, string strServerUserName, string strServerPassword);

member this.FolderExistsOnSqlServer : string * string * string * string -> bool

Public Function FolderExistsOnSqlServer (strFolderName As String, strServerName As String, strServerUserName As String, strServerPassword As String) As Boolean

Parameters

strFolderName: String

The folder you are looking for.

strServerName: String

The name of the instance of SQL Server to search for the package.

strServerUserName: String

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

strServerPassword: String

The password for the given strServerUserName.

Returns

Boolean

true if the folder exists on the specified instance of SQL Server; false if the folder does not exist.

Examples

The following code example creates a folder on SQL Server, renames it, and then removes it. It also verifies the existence of the folder 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 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 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);  
        }

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

Applies to