SqlParameterCollection

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

SqlParameterCollection クラス

SqlCommand に関連付けられたパラメータ コレクション、および DataSet の列に対する各パラメータのマップを表します。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 SqlParameterCollection
    Inherits DbParameterCollection

Visual Basic (使用法)

Dim instance As SqlParameterCollection

C#

public sealed class SqlParameterCollection
 : DbParameterCollection

C++

public ref class SqlParameterCollection sealed
 : public DbParameterCollection

J#

public final class SqlParameterCollection extends
 DbParameterCollection

JScript

public final class SqlParameterCollection extends
 DbParameterCollection

解説

コマンドに、ストアド プロシージャア名ではなく、アドホックな SQL ステートメントが含まれている場合、コレクション内のパラメータ数は、コマンド テキスト内のパラメータ プレースホルダの数と同じにする必要があります。これらが異なると、SQL Server がエラーを発生します。ストアド プロシージャを使用する場合、既定値を使用せずにストアド プロシージャ内で宣言されているすべてのパラメータを提供する必要があります。既定値を使用して宣言されているパラメータは、省略可能です。これにより、既定値以外の値を指定できます。

使用例

SqlParameterCollection コレクションを使用して、SqlParameter の複数のインスタンスを作成する例を次に示します。これらのパラメータは、データ ソース内のデータ選択、および DataSet へのデータの格納に使用されます。このコードでは、DataSet および SqlDataAdapter が、適切なスキーマ、コマンド、および接続で既に作成されていることを前提にしています。

Visual Basic

Public Sub AddSqlParameters()
    ' ...
    ' create categoriesDataSet and categoriesAdapter
    ' ...
    categoriesAdapter.SelectCommand.Parameters.Add( _
        "@CategoryName", SqlDbType.VarChar, 80).Value
 = "toasters"
    categoriesAdapter.SelectCommand.Parameters.Add( _
        "@SerialNum", SqlDbType.Int).Value = 239
    
    categoriesAdapter.Fill(categoriesDataSet)
End Sub  

C#

public void AddSqlParameters() 
{
// ...
// create categoriesDataSet and categoriesAdapter
// ...

  categoriesAdapter.SelectCommand.Parameters.Add(
    "@CategoryName", SqlDbType.VarChar, 80).Value = "toasters";
  categoriesAdapter.SelectCommand.Parameters.Add(
    "@SerialNum", SqlDbType.Int).Value = 239;
  categoriesAdapter.Fill(categoriesDataSet);

}

継承階層

System.Object
   System.MarshalByRefObject
     System.Data.Common.DbParameterCollection
      System.Data.SqlClient.SqlParameterCollection

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
SqlParameterCollection メンバ
System.Data.SqlClient 名前空間
その他の技術情報
ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用

SqlParameterCollection プロパティ

パブリック プロパティ

	名前	説明
	Count	オーバーライドされます。 SqlParameterCollection の要素数を格納している整数を返します。読み取り専用。
	IsFixedSize	オーバーライドされます。 SqlParameterCollection が固定サイズかどうかを示す値を取得します。
	IsReadOnly	オーバーライドされます。 SqlParameterCollection が読み取り専用かどうかを示す値を取得します。
	IsSynchronized	オーバーライドされます。 SqlParameterCollection の同期がとられているかどうかを示す値を取得します。
	Item	オーバーロードされます。 指定した属性を持つ SqlParameter を取得します。
	SyncRoot	オーバーライドされます。 SqlParameterCollection へのアクセスを同期するために使用できるオブジェクトを取得します。

明示的インターフェイスの実装

	名前	説明
	System.Data.IDataParameterCollection.Item

参照

関連項目

SqlParameterCollection クラス
System.Data.SqlClient 名前空間

その他の技術情報

ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用

SqlParameterCollection メソッド

パブリック メソッド

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

	名前	説明
	Add	オーバーロードされます。 オーバーライドされます。 SqlParameter を SqlParameterCollection に追加します。
	AddRange	オーバーロードされます。 オーバーライドされます。 SqlParameterCollection の末尾に要素を追加します。
	AddWithValue	値を SqlParameterCollection の末尾に追加します。
	Clear	オーバーライドされます。 SqlParameterCollection からすべての SqlParameter オブジェクトを削除します。
	Contains	オーバーロードされます。 オーバーライドされます。 指定したオブジェクトがこの SqlParameterCollection 内にあるかどうかを確認します。
	CopyTo	オーバーロードされます。 オーバーライドされます。 指定したオブジェクトに現在の SqlParameterCollection のすべての要素をコピーします。
	CreateObjRef	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 ( MarshalByRefObject から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetEnumerator	オーバーライドされます。 SqlParameterCollection を反復処理する列挙子を返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IndexOf	オーバーロードされます。 オーバーライドされます。 指定した SqlParameter のコレクション内での位置を取得します。
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	Insert	オーバーロードされます。 オーバーライドされます。 SqlParameter オブジェクトを SqlParameterCollection に挿入します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Remove	オーバーロードされます。 オーバーライドされます。 指定した SqlParameter をコレクションから削除します。
	RemoveAt	オーバーロードされます。 オーバーライドされます。 SqlParameterCollection の指定したインデックス位置から SqlParameter オブジェクトを削除します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

SqlParameterCollection クラス
System.Data.SqlClient 名前空間

その他の技術情報

ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用

SqlParameterCollection メンバ

SqlCommand に関連付けられたパラメータ コレクション、および DataSet の列に対する各パラメータのマップを表します。このクラスは継承できません。

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

パブリック プロパティ

	名前	説明
	Count	オーバーライドされます。 SqlParameterCollection の要素数を格納している整数を返します。読み取り専用。
	IsFixedSize	オーバーライドされます。 SqlParameterCollection が固定サイズかどうかを示す値を取得します。
	IsReadOnly	オーバーライドされます。 SqlParameterCollection が読み取り専用かどうかを示す値を取得します。
	IsSynchronized	オーバーライドされます。 SqlParameterCollection の同期がとられているかどうかを示す値を取得します。
	Item	オーバーロードされます。 指定した属性を持つ SqlParameter を取得します。
	SyncRoot	オーバーライドされます。 SqlParameterCollection へのアクセスを同期するために使用できるオブジェクトを取得します。

パブリック メソッド

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

	名前	説明
	Add	オーバーロードされます。 オーバーライドされます。 SqlParameter を SqlParameterCollection に追加します。
	AddRange	オーバーロードされます。 オーバーライドされます。 SqlParameterCollection の末尾に要素を追加します。
	AddWithValue	値を SqlParameterCollection の末尾に追加します。
	Clear	オーバーライドされます。 SqlParameterCollection からすべての SqlParameter オブジェクトを削除します。
	Contains	オーバーロードされます。 オーバーライドされます。 指定したオブジェクトがこの SqlParameterCollection 内にあるかどうかを確認します。
	CopyTo	オーバーロードされます。 オーバーライドされます。 指定したオブジェクトに現在の SqlParameterCollection のすべての要素をコピーします。
	CreateObjRef	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetEnumerator	オーバーライドされます。 SqlParameterCollection を反復処理する列挙子を返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IndexOf	オーバーロードされます。 オーバーライドされます。 指定した SqlParameter のコレクション内での位置を取得します。
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	Insert	オーバーロードされます。 オーバーライドされます。 SqlParameter オブジェクトを SqlParameterCollection に挿入します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Remove	オーバーロードされます。 オーバーライドされます。 指定した SqlParameter をコレクションから削除します。
	RemoveAt	オーバーロードされます。 オーバーライドされます。 SqlParameterCollection の指定したインデックス位置から SqlParameter オブジェクトを削除します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

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

明示的インターフェイスの実装

	名前	説明
	System.Data.IDataParameterCollection.Item

参照

関連項目

SqlParameterCollection クラス
System.Data.SqlClient 名前空間

その他の技術情報

ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用