Application.FolderExistsOnDtsServer Method

Article
12/03/2008

Returns a Boolean that indicates whether the specified folder already exists on the file system.

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

Syntax

'Declaration
Public Function FolderExistsOnDtsServer ( _
    sFolderName As String, _
    sServerName As String _
) As Boolean

public bool FolderExistsOnDtsServer (
    string sFolderName,
    string sServerName
)

public:
bool FolderExistsOnDtsServer (
    String^ sFolderName, 
    String^ sServerName
)

public boolean FolderExistsOnDtsServer (
    String sFolderName, 
    String sServerName
)

public function FolderExistsOnDtsServer (
    sFolderName : String, 
    sServerName : String
) : boolean

Parameters

sFolderName
The name of the folder you are looking for. For example, to see if a folder name myFolder exists under the File System folder, use the escaped string, @"\File System\myFolder".

sServerName
The name of the server to search for the package.

Return Value

true if the folder specified exists on the server; false if the folder does not exist.

Example

The following code example queries the File System to determine whether a folder that was created previously, named myFolder, exists.

class PackageTest
    {
        static void Main(string[] args)
        {
            Application app = new Application();
            Package p = app.LoadPackage(pkg, null);

            String folderName = @"\File System\myFolder";
            String serverName = "yourserver";
            Boolean folderExists = app.FolderExistsOnDtsServer(folderName, serverName);
            Console.WriteLine("Folder exists? " + folderExists);
        }
    }

Class PackageTest
        Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim p As Package =  app.LoadPackage(pkg,Nothing) 
 
            Dim folderName As String =  "\File System\myFolder" 
            Dim serverName As String =  "yourserver" 
            Dim folderExists As Boolean =  app.FolderExistsOnDtsServer(folderName,serverName) 
            Console.WriteLine("Folder exists? " + folderExists)
        End Sub
End Class

Sample Output:

Folder exists? True

Thread Safety

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.

Platforms

Development Platforms

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

Target Platforms