• Article

Server.EnumDetachedDatabaseFiles Method

Enumerates a list of detached database files.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Function EnumDetachedDatabaseFiles ( _
    mdfName As String _
) As StringCollection
'Usage
Dim instance As Server
Dim mdfName As String
Dim returnValue As StringCollection

returnValue = instance.EnumDetachedDatabaseFiles(mdfName)

public StringCollection EnumDetachedDatabaseFiles(
    string mdfName
)

public:
StringCollection^ EnumDetachedDatabaseFiles(
    String^ mdfName
)

member EnumDetachedDatabaseFiles : 
        mdfName:string -> StringCollection 

public function EnumDetachedDatabaseFiles(
    mdfName : String
) : StringCollection

Parameters

  • mdfName
    Type: System.String
    A String value that specifies the file name for which to limit the results.

Return Value

Type: System.Collections.Specialized.StringCollection
A StringCollection system object value that contains a list of detached database file names.

Remarks

Use this method to obtain the names of all detached database (.mdf and .ndf) files on the instance of SQL Server. 

Examples

C#

Server srv = new Server("(local)");
StringCollection sc = srv.EnumDetachedDatabaseFiles("C:\\Program Files\\Microsoft SQL Server\\MSSQL10_50.MSSQLSERVER\\MSSQL\\DATA\\DetachedDatabase.mdf");
foreach (String s in sc)
{
   Console.WriteLine(s);
}

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")

$sc = $srv.EnumDetachedDatabaseFiles("C:\Program Files\Microsoft SQL Server\MSSQL10_50.MSSQLSERVER\MSSQL\DATA\DetachedDatabase.mdf")

Foreach ($s in $sc)
{
   Write-Host $s
}