This documentation is archived and is not being maintained.

SqlConnectionStringBuilder.AttachDBFilename Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets a string that contains the name of the primary file. This includes the full path name of an attachable database.

Namespace: System.Data.SqlClient
Assembly: System.Data (in system.data.dll)

'Declaration
Public Property AttachDBFilename As String
'Usage
Dim instance As SqlConnectionStringBuilder
Dim value As String

value = instance.AttachDBFilename

instance.AttachDBFilename = value
/** @property */
public String get_AttachDBFilename ()

/** @property */
public void set_AttachDBFilename (String value)

public function get AttachDBFilename () : String

public function set AttachDBFilename (value : String)

Property Value

The value of the AttachDBFileName property, or String.Empty if no value has been supplied.

This property corresponds to the "AttachDBFilename", "extended properties", and "initial file name" keys within the connection string. If the value passed in is null when you try to set the property, the AttachDBFilename property is reset. If the value has not been set and the developer tries to retrieve the property, the return value is String.Empty.

The following example creates a new SqlConnectionStringBuilder instance, and sets the AttachDBFilename property in order to specify the name of an attached data file.

Imports System.Data.SqlClient

Module Module1
    Sub Main()
        Try
            Dim connectString As String = _
             "Server=(local);" & _
             "Integrated Security=True"
            Dim builder As New SqlConnectionStringBuilder(connectString)
            Console.WriteLine("Original: " & builder.ConnectionString)
            Console.WriteLine("AttachDBFileName={0", _
             builder.AttachDBFilename)
            builder.AttachDBFilename = "C:\MyDatabase.mdf"
            Console.WriteLine("Modified: " & builder.ConnectionString)

            Using connection As New SqlConnection(builder.ConnectionString)
                connection.Open()
                ' Now use the open connection.
                Console.WriteLine("Database = " & connection.Database)
            End Using

            Console.WriteLine("Press any key to finish.")
            Console.ReadLine()

        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try
    End Sub
End Module

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0
Show: