ConnectionStringSettingsとは？ わかりやすく解説

Public NotInheritable Class
 ConnectionStringSettings
    Inherits ConfigurationElement

Dim instance As ConnectionStringSettings

public sealed class ConnectionStringSettings
 : ConfigurationElement

public ref class ConnectionStringSettings sealed
 : public ConfigurationElement

public final class ConnectionStringSettings
 extends ConfigurationElement

public final class ConnectionStringSettings
 extends ConfigurationElement

解説

ConnectionStringSettings オブジェクトは、connectionStrings 構成ファイルセクションの 1 つのエントリを表します。

Topic	Location
方法 : Web.config ファイルから接続文字列を読み取る	ASP .NET Web アプリケーションの構成
方法 : データソースコントロールを使用するときに接続文字列をセキュリティ保護する	ASP .NET Web アプリケーションの作成
方法 : データソースコントロールを使用するときに接続文字列をセキュリティ保護する (Visual Studio)	Visual Studio での ASP .NET Web アプリケーションの作成
方法 : 定義済みの資格情報を使用して SQL Server にアクセスする	ASP .NET Web アプリケーションの作成

使用例

ConnectionStringSettingsCollection コレクション内の指定したインデックス位置にある ConnectionStringSettings オブジェクトにアクセスする方法の例を次に示します。

Visual Basic

Shared Sub ShowConnectionStrings() 

    ' Get the application configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)

    ' Get the conectionStrings section.
    Dim csSection _
    As ConnectionStringsSection = _
    config.ConnectionStrings
    
    Dim i As Integer
    For i = 0 To ConfigurationManager.ConnectionStrings.Count
        Dim cs As ConnectionStringSettings
 = _
        csSection.ConnectionStrings(i)
        
        Console.WriteLine( _
        "  Connection String: ""{0}""",
 cs.ConnectionString)
        Console.WriteLine("#{0}", i)
        Console.WriteLine("  Name: {0}", cs.Name)
        
        Console.WriteLine( _
        "  Provider Name: {0}", cs.ProviderName)

    Next i

End Sub 'ShowConnectionStrings

static void ShowConnectionStrings()
{
     // Get the application configuration file.
    System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(
            ConfigurationUserLevel.None);

    // Get the conectionStrings section.
    ConnectionStringsSection csSection =
        config.ConnectionStrings;
    
    for (int i = 0; i < 
        ConfigurationManager.ConnectionStrings.Count; i++)
    {
        ConnectionStringSettings cs = 
            csSection.ConnectionStrings[i];
        
        Console.WriteLine("  Connection String: \"{0}\"",
            cs.ConnectionString);

        Console.WriteLine("#{0}", i);
        Console.WriteLine("  Name: {0}", cs.Name);
     
        
        Console.WriteLine("  Provider Name: {0}", 
            cs.ProviderName);
        
    }

}

前述の例で使用されている構成の抜粋を次に示します。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <connectionStrings>
    <add name="ConnStr1" connectionString="LocalSqlServer: data source=127.0.0.1;Integrated
 Security=SSPI;Initial Catalog=aspnetdb"
      providerName="System.Data.SqlClient" />
  </connectionStrings>
</configuration>

継承階層

System.Object
System.Configuration.ConfigurationElement
System.Configuration.ConnectionStringSettings

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

.NET Framework
サポート対象 : 2.0

関連項目
ConnectionStringSettings メンバ
System.Configuration 名前空間
ConnectionStringsSection
ConnectionStringSettingsCollection
その他の技術情報
connectionStrings 要素 (ASP.NET 設定スキーマ)

ConnectionStringSettings コンストラクタ ()

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

ConnectionStringSettings クラスの新しいインスタンスを初期化します。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Public Sub New

Dim instance As New ConnectionStringSettings

public ConnectionStringSettings ()

public:
ConnectionStringSettings ()

public ConnectionStringSettings ()

public function ConnectionStringSettings ()

.NET Framework
サポート対象 : 2.0

関連項目
ConnectionStringSettings クラス
ConnectionStringSettings メンバ
System.Configuration 名前空間
ConnectionStringsSection
ConnectionStringSettingsCollection
ConnectionStringsSection
ConnectionStringSettingsCollection

ConnectionStringSettings コンストラクタ (String, String, String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

ConnectionStringSettings オブジェクトの新しいインスタンスを初期化します。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Public Sub New ( _
    name As String, _
    connectionString As String, _
    providerName As String _
)

Dim name As String
Dim connectionString As String
Dim providerName As String

Dim instance As New ConnectionStringSettings(name,
 connectionString, providerName)

public ConnectionStringSettings (
    string name,
    string connectionString,
    string providerName
)

public:
ConnectionStringSettings (
    String^ name, 
    String^ connectionString, 
    String^ providerName
)

public ConnectionStringSettings (
    String name, 
    String connectionString, 
    String providerName
)

public function ConnectionStringSettings (
    name : String, 
    connectionString : String, 
    providerName : String
)

パラメータ

name: 接続文字列の名前。

connectionString: 接続文字列。

providerName: 接続文字列と共に使用するプロバイダの名前。

使用例

ConnectionStringSettings オブジェクトを作成し、ConnectionStringSettingsCollection コレクションに追加する方法の例を次に示します。

Visual Basic

' Add the connection string.
Dim csSection _
As ConnectionStringsSection = _
config.ConnectionStrings
csSection.ConnectionStrings.Add( _
New ConnectionStringSettings(csName, _
"LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;"
 _
+ "Initial Catalog=aspnetdb", "System.Data.SqlClient"))

// Add the connection string.
ConnectionStringsSection csSection =
    config.ConnectionStrings;
csSection.ConnectionStrings.Add(
    new ConnectionStringSettings(csName,
        "LocalSqlServer: data source=127.0.0.1;Integrated Security=SSPI;"
 +
        "Initial Catalog=aspnetdb", "System.Data.SqlClient"));

.NET Framework
サポート対象 : 2.0

関連項目
ConnectionStringSettings クラス
ConnectionStringSettings メンバ
System.Configuration 名前空間
ConnectionStringsSection
ConnectionStringSettingsCollection

ConnectionStringSettings コンストラクタ

ConnectionStringSettings クラスの新しいインスタンスを初期化します。 ConnectionStringsSection ConnectionStringSettingsCollection
オーバーロードの一覧

名前	説明
ConnectionStringSettings ()	ConnectionStringSettings クラスの新しいインスタンスを初期化します。
ConnectionStringSettings (String, String)	ConnectionStringSettings クラスの新しいインスタンスを初期化します。
ConnectionStringSettings (String, String, String)	ConnectionStringSettings オブジェクトの新しいインスタンスを初期化します。

ConnectionStringSettings コンストラクタ (String, String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

ConnectionStringSettings クラスの新しいインスタンスを初期化します。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Public Sub New ( _
    name As String, _
    connectionString As String _
)

Dim name As String
Dim connectionString As String

Dim instance As New ConnectionStringSettings(name,
 connectionString)

public ConnectionStringSettings (
    string name,
    string connectionString
)

public:
ConnectionStringSettings (
    String^ name, 
    String^ connectionString
)

public ConnectionStringSettings (
    String name, 
    String connectionString
)

public function ConnectionStringSettings (
    name : String, 
    connectionString : String
)

パラメータ

name: 接続文字列の名前。

connectionString: 接続文字列。

.NET Framework
サポート対象 : 2.0

関連項目
ConnectionStringSettings クラス
ConnectionStringSettings メンバ
System.Configuration 名前空間
ConnectionStringsSection
ConnectionStringSettingsCollection

ConnectionStringSettings プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	ConnectionString	接続文字列を取得または設定します。
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 ( ConfigurationElement から継承されます。)
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。 ( ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。 ( ConfigurationElement から継承されます。)
	Name	ConnectionStringSettings 名を取得または設定します。
	ProviderName	プロバイダ名プロパティを取得または設定します。

その他の技術情報

connectionStrings 要素 (ASP.NET 設定スキーマ)

ConnectionStringSettings メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 ( ConfigurationElement から継承されます。)
	GetHashCode	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 ( ConfigurationElement から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 ( ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	オーバーライドされます。オブジェクトの文字列形式を返します。

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

その他の技術情報

connectionStrings 要素 (ASP.NET 設定スキーマ)

ConnectionStringSettings メンバ

構成ファイルの接続文字列セクション内の名前付きで単一の接続文字列を表します。

ConnectionStringSettings データ型で公開されるメンバを以下の表に示します。

パブリックコンストラクタ

	名前	説明
	ConnectionStringSettings	オーバーロードされます。 ConnectionStringSettings クラスの新しいインスタンスを初期化します。

パブリックプロパティ

	名前	説明
	ConnectionString	接続文字列を取得または設定します。
	ElementInformation	ConfigurationElement オブジェクトのカスタマイズできない情報と機能を格納する ElementInformation オブジェクトを取得します。 (ConfigurationElement から継承されます。)
	LockAllAttributesExcept	ロックされている属性のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAllElementsExcept	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockAttributes	ロックされている属性のコレクションを取得します。 (ConfigurationElement から継承されます。)
	LockElements	ロックされている要素のコレクションを取得します。(ConfigurationElement から継承されます。)
	LockItem	要素がロックされているかどうかを示す値を取得または設定します。(ConfigurationElement から継承されます。)
	Name	ConnectionStringSettings 名を取得または設定します。
	ProviderName	プロバイダ名プロパティを取得または設定します。

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 (ConfigurationElement から継承されます。)
	GetHashCode	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 (ConfigurationElement から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsReadOnly	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (ConfigurationElement から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	オーバーライドされます。オブジェクトの文字列形式を返します。

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)