Freigeben über

IDataParameter Schnittstelle

Definition

Namespace:
System.Data
Assemblys:
netstandard.dll, System.Data.Common.dll
Assembly:
System.Data.Common.dll
Assembly:
System.Data.dll
Assembly:
netstandard.dll
Quelle:
IDataParameter.cs
Quelle:
IDataParameter.cs

Stellt einen Parameter für ein Command -Objekt und optional die Zuordnung zu DataSet Spalten 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 Auflistung innerhalb der SqlParameterCollectionSqlDataAdapter. 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 DataSet und eine SqlDataAdapter bereits mit dem entsprechenden Schema, den entsprechenden Befehlen und der 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 geerbten 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, sondern erstellt 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. Beispielsweise definiert die IDataParameter Schnittstelle die DbType Eigenschaft. Die Klasse erbt wiederum OleDbParameter 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 geerbte Klasse im Formularparameter Prv , wobei Prv das einheitliche Präfix für alle Klassen in einem bestimmten .NET Framework-Datenanbieternamespace angegeben ist. Ist beispielsweise Sql 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 Parameter-Klasse.
PrvParameter(string name, PrvDbType dataType) Initialisiert eine neue Instanz der Parameterklasse mit dem Parameternamen und Datentyp.
PrvParameter(string name, object value) 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, Datentyp und Breite.
PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) Initialisiert eine neue Instanz der DbParameter-Klasse mit dem Parameternamen, Datentyp, Breite 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 Instanz der OleDbParameter Klasse mit dem Parameternamen, Datentyp, Breite, Quellspaltennamen, Parameterrichtung, numerischer Genauigkeit und anderen Eigenschaften.

Eigenschaften

Name Beschreibung
DbType

Dient zum DbType Abrufen oder Festlegen des Parameters.
Direction

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Parameter eingabegeschützt, ausgabegeschützt, bidirektional oder ein gespeicherter Prozedur-Rückgabewertparameter ist.
IsNullable

Ruft einen Wert ab, der angibt, ob der Parameter NULL-Werte akzeptiert.
ParameterName

Dient zum Abrufen oder Festlegen des Namens der IDataParameter.
SourceColumn

Dient zum Abrufen oder Festlegen des Namens der Quellspalte, die dem DataSet Laden oder Zurückgeben der ValueQuellspalte zugeordnet und verwendet wird.
SourceVersion

Dient zum Abrufen oder Festlegen der DataRowVersion zu verwendenden Eigenschaft beim Laden Value.
Value

Dient zum Abrufen oder Festlegen des Werts des Parameters.

Gilt für: