IDataParameter IDataParameter IDataParameter IDataParameter Interface

定義

Command オブジェクトへのパラメーター、さらに必要に応じて DataSet 列へのそれらのマッピングを表し、データ ソースにアクセスする .NET Framework データ プロバイダーによって実装されます。Represents a parameter to a Command object, and optionally, its mapping to DataSet columns; and is implemented by .NET Framework data providers that access data sources.

public interface class IDataParameter
public interface IDataParameter
type IDataParameter = interface
Public Interface IDataParameter
派生

次の例では、のSqlParameter SqlDataAdapterコレクションをSqlParameterCollection使用して、派生クラスの複数のインスタンスを作成します。The following example creates multiple instances of the derived class, SqlParameter, through the SqlParameterCollection collection within the SqlDataAdapter. これらのパラメーターは、 DataSetデータソースからデータを選択し、にデータを配置するために使用されます。These parameters are used to select data from the data source and place the data in the DataSet. この例ではDataSetSqlDataAdapterとが、適切なスキーマ、コマンド、および接続を使用して既に作成されていることを前提としています。This example assumes that a DataSet and a SqlDataAdapter have already been created with the appropriate schema, commands, and connection.

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インターフェイスを使用すると、継承クラスは、コマンドオブジェクトのパラメーターを表すパラメータークラスを実装できます。The IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. パラメータークラスの詳細については、「パラメーターおよびパラメーターデータ型の構成」を参照してください。For more information about Parameter classes, see Configuring Parameters and Parameter Data Types.

アプリケーションは、 IDataParameterインターフェイスのインスタンスを直接作成するのではなく、を継承IDataParameterするクラスのインスタンスを作成します。An application does not create an instance of the IDataParameter interface directly, but creates an instance of a class that inherits IDataParameter.

継承IDataParameterするクラスは、継承されたメンバーを実装する必要があり、通常は、プロバイダー固有の機能を追加するための追加メンバーを定義します。Classes that inherit IDataParameter must implement the inherited members, and typically define additional members to add provider-specific functionality. たとえば、インターフェイスはIDataParameter DbTypeプロパティを定義します。For example, the IDataParameter interface defines the DbType property. 次に、クラスOleDbParameterはこのプロパティを継承し、 OleDbTypeプロパティも定義します。In turn, the OleDbParameter class inherits this property, and also defines the OleDbType property.

注意 (実装者)

.NET Framework データプロバイダー間の一貫性を高めるには、フォームPrvパラメーターに継承クラスの名前を付けます。ここPrvで、は、特定の .NET Framework データプロバイダーの名前空間のすべてのクラスに指定された一様なプレフィックスです。To promote consistency among .NET Framework data providers, name the inheriting class in the form Prv Parameter where Prv is the uniform prefix given to all classes in a specific .NET Framework data provider namespace. たとえば、 SqlSystem.Data.SqlClient名前空間のSqlCommandクラスのプレフィックスです。For example, Sql is the prefix of the SqlCommand class in the System.Data.SqlClient namespace.

IDataParameterインターフェイスから継承する場合は、次のコンストラクターを実装する必要があります。When you inherit from the IDataParameter interface, you should implement the following constructors:

アイテムItem 説明Description
PrvParameter()PrvParameter() Parameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the Parameter class.

PrvParameter (文字列名、PrvDbType dataType)PrvParameter(string name, PrvDbType dataType) パラメーター名とデータ型を指定して、パラメータークラスの新しいインスタンスを初期化します。Initializes a new instance of the Parameter class with the parameter name and data type.

PrvParameter (文字列名、オブジェクト値)PrvParameter(string name, object value) パラメーター名、およびパラメーターの値であるオブジェクトを使用して、パラメータークラスの新しいインスタンスを初期化します。Initializes a new instance of the Parameter class with the parameter name and an object that is the value of the Parameter.

PrvParameter (string name, PrvDbType dataType, int size)PrvParameter(string name, PrvDbType dataType, int size) パラメーター名、データ型、および幅を指定して、パラメータークラスの新しいインスタンスを初期化します。Initializes a new instance of the Parameter class with the parameter name, data type, and width.

PrvParameter (string name, PrvDbType dataType, int size, string srcColumn)PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) パラメーター名、データ型、幅、およびソース列名を指定して、DbParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the DbParameter class with the parameter name, data type, width, and source column name.

PrvParameter (文字列 parameterName、PrvDbType dbType、int size、ParameterDirection direction、Boolean isNullable、Byte precision、Byte scale、string srcColumn、DataRowVersion Srccolumn、オブジェクト値)PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value) パラメーター名、データ型、 OleDbParameter幅、ソース列名、パラメーターの方向、数値の有効桁数、およびその他のプロパティを使用して、クラスの新しいインスタンスを初期化します。Initializes a new instance of the OleDbParameter class with the parameter name, data type, width, source column name, parameter direction, numeric precision, and other properties.

プロパティ

DbType DbType DbType DbType

パラメーターの DbType を取得または設定します。Gets or sets the DbType of the parameter.

Direction Direction Direction Direction

パラメーターが入力専用、出力専用、双方向、またはストアド プロシージャの戻り値パラメーターのいずれであるかを示す値を取得または設定します。Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

IsNullable IsNullable IsNullable IsNullable

パラメーターが null 値を受け取るかどうかを示す値を取得します。Gets a value indicating whether the parameter accepts null values.

ParameterName ParameterName ParameterName ParameterName

IDataParameter の名前を取得または設定します。Gets or sets the name of the IDataParameter.

SourceColumn SourceColumn SourceColumn SourceColumn

DataSet にマップされ、Value を読み込んだり返したりするために使用されるソース列の名前を取得または設定します。Gets or sets the name of the source column that is mapped to the DataSet and used for loading or returning the Value.

SourceVersion SourceVersion SourceVersion SourceVersion

Value を読み込むときに使用する DataRowVersion を取得または設定します。Gets or sets the DataRowVersion to use when loading Value.

Value Value Value Value

パラメーターの値を取得または設定します。Gets or sets the value of the parameter.

適用対象