SqlConnectionStringBuilder.ApplicationName Property

Reference

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Package:: System.Data.SqlClient v4.8.6

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.

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

public:
 property System::String ^ ApplicationName { System::String ^ get(); void set(System::String ^ value); };

public string ApplicationName { get; set; }

member this.ApplicationName : string with get, set

Public Property ApplicationName As String

Property Value

String

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

Exceptions

ArgumentNullException

To set the value to null, use Value.

Examples

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.

using System.Data.SqlClient;

class Program
{
    static void Main()
    {
        try
        {
            string connectString = "Server=(local);Initial Catalog=AdventureWorks;" +
                "Integrated Security=true";
            SqlConnectionStringBuilder builder =
                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 (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}

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"

Remarks

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

Applies to

Partager via