IDataParameter インターフェイス

定義

名前空間:

System.Data

アセンブリ:

System.Data.Common.dll

Command オブジェクトへのパラメーター、さらに必要に応じて DataSet 列へのそのマッピングを表し、データ ソースにアクセスする .NET データ プロバイダーによって実装されます。

public interface class IDataParameter

public interface IDataParameter

type IDataParameter = interface

Public Interface IDataParameter

派生

System.Data.Common.DbParameter

System.Data.EntityClient.EntityParameter

System.Data.IDbDataParameter

System.Data.Odbc.OdbcParameter

System.Data.OleDb.OleDbParameter

System.Data.OracleClient.OracleParameter

例

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

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

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

注釈

IDataParameterインターフェイスを使用すると、継承クラスは、Command オブジェクトへのパラメーターを表す Parameter クラスを実装できます。 パラメーター クラスの詳細については、「 パラメーターとパラメーター データ型の構成」を参照してください。

アプリケーションは インターフェイスの IDataParameter インスタンスを直接作成するのではなく、 を継承するクラスのインスタンスを作成します IDataParameter。

IDataParameter を継承するクラスは、継承されたメンバーを実装し、通常は、プロバイダー固有の機能を追加するための追加メンバーを定義する必要があります。 たとえば、 インターフェイスは IDataParameter プロパティを DbType 定義します。 さらに、 クラスはこのプロパティを OleDbParameter 継承し、 プロパティも定義します OleDbType 。

注意 (実装者)

.NET Framework データ プロバイダー間の一貫性を高めるために、継承クラスに Parameter という形式Prvで名前を付けます。ここでPrv、 は、特定の.NET Frameworkデータ プロバイダー名前空間内のすべてのクラスに与えられる統一されたプレフィックスです。 たとえば、 Sql は 名前空間の System.Data.SqlClient クラスのSqlCommandプレフィックスです。

インターフェイスから IDataParameter 継承する場合は、次のコンストラクターを実装する必要があります。

アイテム	説明
PrvParameter()	Parameter クラスの新しいインスタンスを初期化します。
PrvParameter(string name, PrvDbType dataType)	パラメーター名とデータ型を使用して、Parameter クラスの新しいインスタンスを初期化します。
PrvParameter(string name, object value)	パラメーター名と Parameter の値であるオブジェクトを使用して、 Parameter クラスの新しいインスタンスを初期化します。
PrvParameter(string name, PrvDbType dataType, int size)	パラメーター名、データ型、および幅を使用して、Parameter クラスの新しいインスタンスを初期化します。
PrvParameter(string name, PrvDbType dataType, int size, string srcColumn)	パラメーター名、データ型、幅、およびソース列名を使用して、DbParameter クラスの新しいインスタンスを初期化します。
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value)	パラメーター名、データ型、幅、ソース列名、パラメーターの OleDbParameter 方向、数値精度、その他のプロパティを使用して、 クラスの新しいインスタンスを初期化します。

プロパティ

DbType	パラメーターの DbType を取得または設定します。
Direction	パラメーターが入力専用、出力専用、双方向、またはストアド プロシージャの戻り値パラメーターのいずれであるかを示す値を取得または設定します。
IsNullable	パラメーターが null 値を受け取るかどうかを示す値を取得します。
ParameterName	IDataParameter の名前を取得または設定します。
SourceColumn	DataSet にマップされ、Value を読み込んだり返したりするために使用されるソース列の名前を取得または設定します。
SourceVersion	Value を読み込むときに使用する DataRowVersion を取得または設定します。
Value	パラメーターの値を取得または設定します。