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を使用して、SqlParameterCollection内のコレクション、SqlDataAdapterします。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 データ プロバイダー名前空間のすべてのクラスに指定された uniform プレフィックスです。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. たとえば、Sqlのプレフィックスは、SqlCommandクラス、System.Data.SqlClient名前空間。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() パラメーターのクラスの新しいインスタンスを初期化します。Initializes a new instance of the Parameter class.

PrvParameter (文字列名、PrvDbType データ型)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 (文字列名、PrvDbType データ型、int サイズ、文字列 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 サイズ、ParameterDirection 方向、ブール型の isNullable、バイトの有効桁数、バイトのスケール、文字列 srcColumn、DataRowVersion srcVersion、オブジェクトの値)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.

適用対象