SqlConnectionStringBuilder::InitialCatalog Property

.NET Framework (current version)

Gets or sets the name of the database associated with the connection.

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

Syntax

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

Property Value

Type: System::String^

The value of the InitialCatalog property, or String.Empty if none has been supplied.

Exceptions

Exception	Condition
ArgumentNullException	To set the value to null, use Value.

Remarks

This property corresponds to the "Initial Catalog" and "database" keys within the connection string.

The following example creates a simple connection string and then uses the SqlConnectionStringBuilder class to add the name of the database to the connection string. The code displays the contents of the InitialCatalog property, just to verify that the class was able to convert from the synonym ("Database") to the appropriate property value.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 2.0