IDataParameter インターフェイス

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

IDataParameter インターフェイス

Command オブジェクトに対するパラメータと、オプションとして DataSet 列へのマップを表します。データ ソースにアクセスする .NET Framework データ プロバイダによって実装されます。

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

Visual Basic (宣言)

Public Interface IDataParameter

Visual Basic (使用法)

Dim instance As IDataParameter

C#

public interface IDataParameter

C++

public interface class IDataParameter

J#

public interface IDataParameter

JScript

public interface IDataParameter

解説

IDataParameter インターフェイスによって、継承クラスは Command オブジェクトに対するパラメータを表す Parameter クラスを実装できます。Parameter クラスの詳細については、「コマンドによるストアド プロシージャの使用」を参照してください。.NET Framework データ プロバイダの実装の詳細については、「Implementing a .NET Framework Data Provider」を参照してください。

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

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

実装時の注意 .NET Framework データ プロバイダ間に一貫性を持たせるために、継承クラスには Prv Parameter という形式の名前を付けてください。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 クラスの新しいインスタンスを初期化します。

使用例

SqlDataAdapter 内の 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);

}

プラットフォーム

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

参照

関連項目
IDataParameter メンバ
System.Data 名前空間