IDataParameter Schnittstelle

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Stellt einen Parameter sowie optional dessen Zuordnung zu DataSet-Spalten für ein Command-Objekt dar und wird von .NET-Datenanbietern implementiert, die auf Datenquellen zugreifen.

public interface class IDataParameter

public interface IDataParameter

type IDataParameter = interface

Public Interface IDataParameter

Abgeleitet

System.Data.Common.DbParameter

System.Data.EntityClient.EntityParameter

System.Data.IDbDataParameter

System.Data.Odbc.OdbcParameter

System.Data.OleDb.OleDbParameter

System.Data.OracleClient.OracleParameter

Beispiele

Im folgenden Beispiel werden mehrere Instanzen der abgeleiteten Klasse erstellt, SqlParameterüber die SqlParameterCollection -Auflistung innerhalb von SqlDataAdapter. Diese Parameter werden verwendet, um Daten aus der Datenquelle auszuwählen und die Daten im zu DataSetplatzieren. In diesem Beispiel wird davon ausgegangen, dass ein DataSet und bereits SqlDataAdapter mit dem entsprechenden Schema, den entsprechenden Befehlen und der entsprechenden Verbindung erstellt wurden.

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

Hinweise

Die IDataParameter -Schnittstelle ermöglicht es einer erbenden Klasse, eine Parameter-Klasse zu implementieren, die einen Parameter für ein Command-Objekt darstellt. Weitere Informationen zu Parameterklassen finden Sie unter Konfigurieren von Parametern und Parameterdatentypen.

Eine Anwendung erstellt nicht direkt eine instance der IDataParameter Schnittstelle, sondern eine instance einer Klasse, die erbtIDataParameter.

Klassen, die erben IDataParameter , müssen die geerbten Member implementieren und in der Regel zusätzliche Member definieren, um anbieterspezifische Funktionen hinzuzufügen. Beispielsweise definiert die IDataParameter -Schnittstelle die DbType -Eigenschaft. Die -Klasse wiederum OleDbParameter erbt diese Eigenschaft und definiert auch die OleDbType -Eigenschaft.

Hinweise für Ausführende

Um die Konsistenz zwischen .NET Framework Datenanbietern zu fördern, benennen Sie die erbende Klasse im Format Prv Parameter, wobei Prv das einheitliche Präfix ist, das allen Klassen in einem bestimmten .NET Framework-Datenanbieternamespace zugewiesen wird. Beispielsweise Sql ist das Präfix der SqlCommand -Klasse im System.Data.SqlClient -Namespace.

Wenn Sie von der IDataParameter -Schnittstelle erben, sollten Sie die folgenden Konstruktoren implementieren:

Element	Beschreibung
PrvParameter()	Initialisiert eine neue instance der Parameter-Klasse.
PrvParameter(string name, PrvDbType dataType)	Initialisiert eine neue instance der Parameterklasse mit dem Parameternamen und Datentyp.
PrvParameter(Zeichenfolgenname, Objektwert)	Initialisiert eine neue instance der Parameterklasse mit dem Parameternamen und einem Objekt, das dem Wert des Parameters entspricht.
PrvParameter(string name, PrvDbType dataType, int size)	Initialisiert eine neue instance der Parameterklasse mit dem Parameternamen, Datentyp und der Breite.
PrvParameter(string name, PrvDbType dataType, int size, string srcColumn)	Initialisiert eine neue instance der DbParameter-Klasse mit dem Parameternamen, Datentyp, Width und Quellspaltennamen.
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value)	Initialisiert eine neue instance der OleDbParameter -Klasse mit dem Parameternamen, datentyp, der Breite, dem Namen der Quellspalte, der Parameterrichtung, der numerischen Genauigkeit und anderen Eigenschaften.

Eigenschaften

DbType	Ruft den DbType des Parameters ab oder legt ihn fest.
Direction	Ruft einen Wert ab, der angibt, ob der Parameter nur zur Eingabe, nur zur Ausgabe oder bidirektional verwendet wird oder ob es sich um einen Parameter für den Rückgabewert einer gespeicherten Prozedur handelt, oder legt diesen Wert fest.
IsNullable	Ruft einen Wert ab, der anzeigt, ob der Parameter NULL-Werte akzeptiert.
ParameterName	Ruft den Namen der IDataParameter ab oder legt diesen fest.
SourceColumn	Ruft den Namen der Quellspalte ab, die dem DataSet zugeordnet ist und zum Laden oder Zurückgeben des Value verwendet wird, oder legt diesen Namen fest.
SourceVersion	Ruft die DataRowVersion ab, die beim Laden von Value verwendet werden soll, oder legt diese fest.
Value	Ruft den Wert des Parameters ab oder legt diesen fest.