SqlConnectionStringBuilder.InitialCatalog プロパティ

.NET Framework クラス ライブラリ リファレンス

SqlConnectionStringBuilder.InitialCatalog プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

接続に関連付けられたデータベースの名前を取得または設定します。

名前空間: System.Data.SqlClient
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Property InitialCatalog As
 String

Visual Basic (使用法)

Dim instance As SqlConnectionStringBuilder
Dim value As String

value = instance.InitialCatalog

instance.InitialCatalog = value

C#

public string InitialCatalog { get;
 set; }

C++

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

J#

/** @property */
public String get_InitialCatalog ()

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

JScript

public function get InitialCatalog
 () : String

public function set InitialCatalog
 (value : String)

プロパティ値
InitialCatalog プロパティの値。何も指定されていない場合は String.Empty。

解説

このプロパティは、接続文字列内の "Initial Catalog" キーおよび "database" キーに対応します。

プロパティを設定するときに渡された値が null の場合、InitialCatalog プロパティはリセットされます。値が設定されていない場合に開発者がプロパティを取得しようとすると、String.Empty が返されます。

使用例

次の例では、単純な接続文字列を作成し、SqlConnectionStringBuilder クラスを使用して、データベースの名前を接続文字列に追加します。このクラスによって、シノニム ("Database") が適切なプロパティ値に変換されたことを確認できるよう、InitialCatalog プロパティの内容が表示されます。

Visual Basic

Imports System.Data.SqlClient
    
Module Module1
    Sub Main()
        Try
            Dim connectString As String
 = _
             "Data Source=(local);" & _
             "Integrated Security=True"

            Dim builder As New
 SqlConnectionStringBuilder(connectString)
            Console.WriteLine("Original: " & builder.ConnectionString)

            ' Normally, you could simply set the InitialCatalog
            ' property of the SqlConnectionStringBuilder object. This
            ' example uses the default Item property (the C# indexer)
            ' and the "Database" string, simply to demonstrate
 that
            ' setting the value in this way results in the same
            ' connection string.
            builder("Database") = "AdventureWorks"
            Console.WriteLine("builder.InitialCatalog = "
 _
                & builder.InitialCatalog)
            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

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

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

C#

using System.Data.SqlClient;

class Program
{
    static void Main()
    {
        try
        {
            string connectString = "Data Source=(local);"
 +
                "Integrated Security=true";

            SqlConnectionStringBuilder builder = 
                new SqlConnectionStringBuilder(connectString);
            Console.WriteLine("Original: " + builder.ConnectionString);

            // Normally, you could simply set the InitialCatalog
            // property of the SqlConnectionStringBuilder object. This
            // example uses the default Item property (the C# indexer)
            // and the "Database" string, simply to demonstrate
 that
            // setting the value in this way results in the same
            // connection string:
            builder["Database"] = "AdventureWorks";
            Console.WriteLine("builder.InitialCatalog = " 
                + builder.InitialCatalog);
            Console.WriteLine("Modified: " + builder.ConnectionString);

            using (SqlConnection connection = 
                new SqlConnection(builder.ConnectionString))
            {
                connection.Open();
                // Now use the open connection.
                Console.WriteLine("Database = " + connection.Database);
            }

        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }

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

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SqlConnectionStringBuilder クラス
SqlConnectionStringBuilder メンバ
System.Data.SqlClient 名前空間
その他の技術情報
接続文字列の使用