Export (0) Print
Expand All

SqlConnectionStringBuilder.ApplicationName Property

Gets or sets the name of the application associated with the connection string.

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

'Declaration
Public Property ApplicationName As String

Property Value

Type: System.String
The name of the application, or ".NET SqlClient Data Provider" if no name has been supplied.

ExceptionCondition
ArgumentNullException

To set the value to null, use Value.

This property corresponds to the "Application Name" and "app" keys within the connection string.

The following example creates a new SqlConnectionStringBuilder and assigns a connection string in the object's constructor. The code displays the parsed and recreated version of the connection string, and then modifies the ApplicationName property of the object. Finally, the code displays the new connection string, including the new key/value pair.

Imports System.Data.SqlClient

Module Module1

    Sub Main()
        Try 
            Dim connectString As String = _
             "Server=(local);Initial Catalog=AdventureWorks;" & _
                 "Integrated Security=True" 
            Dim builder As New SqlConnectionStringBuilder(connectString)
            Console.WriteLine("Original: " & builder.ConnectionString)
            Console.WriteLine("ApplicationName={0}", _
                builder.ApplicationName)
            builder.ApplicationName = "My Application"
            Console.WriteLine("Modified: " & builder.ConnectionString)

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

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

The sample displays the following text in the console window:

Original: Data Source=(local);Initial Catalog=AdventureWorks;Integrated Security=True
ApplicationName=".Net SqlClient Data Provider"
Modified: Data Source=(local);Initial Catalog=AdventureWorks;Integrated Security=True;Application Name="My Application"

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft