SqlConnectionStringBuilder.ApplicationName Property

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

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. If no name has been supplied, "Framework Microsoft SqlClient Data Provider" when running on .NET Framework and "Core Microsoft SqlClient Data Provider" otherwise.

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 Microsoft.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);
        }
    }
}

The sample displays the following text in the console window:

Original: Data Source=(local);Initial Catalog=AdventureWorks;Integrated Security=True  
ApplicationName="Core Microsoft 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.

An application name can be 128 characters or less.