IDataParameter Schnittstelle

Definition

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

Beispiele

Im folgenden Beispiel werden mehrere Instanzen der abgeleiteten Klasse, SqlParameterüber die SqlParameterCollection Auflistung innerhalb der SqlDataAdapterAuflistung erstellt. Diese Parameter werden verwendet, um Daten aus der Datenquelle auszuwählen und die Daten in der DataSet. In diesem Beispiel wird davon ausgegangen, dass eine und eine DataSet SqlDataAdapter bereits mit dem entsprechenden Schema, Befehlen und Verbindung erstellt wurde.

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 Parameterklasse 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 keine Instanz der IDataParameter Schnittstelle direkt, erstellt aber eine Instanz einer Klasse, die erbt IDataParameter.

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

Hinweise für Ausführende

Um die Konsistenz zwischen .NET Framework Datenanbietern zu fördern, benennen Sie die erbende Klasse im FormularparameterPrv, wobei Prv das einheitliche Präfix für alle Klassen in einem bestimmten .NET Framework Datenanbieter-Namespace angegeben ist. 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 Instanz der Parameterklasse.
PrvParameter(string name, PrvDbType dataType) Initialisiert eine neue Instanz der Parameterklasse mit dem Parameternamen und dem Datentyp.
PrvParameter(Zeichenfolgenname, Objektwert) Initialisiert eine neue Instanz der Parameterklasse mit dem Parameternamen und einem Objekt, das den Wert des Parameters darstellt.
PrvParameter(string name, PrvDbType dataType, int size) Initialisiert eine neue Instanz der Parameterklasse mit dem Parameternamen, dem Datentyp und der Breite.
PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) Initialisiert eine neue Instanz der DbParameter-Klasse mit dem Parameternamen, dem Datentyp, der Breite und dem Quellspaltennamen.
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, Objektwert) Initialisiert eine neue Instanz der Klasse mit dem Parameternamen, dem Datentyp, der OleDbParameter Breite, dem Quellspaltennamen, 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.

Gilt für: