IDataParameter-Schnittstelle
Stellt einen Parameter für ein Command-Objekt sowie optional dessen Zuordnung zu DataSet-Spalten dar und wird durch .NET Framework-Datenanbieter implementiert, die auf Datenquellen zugreifen.
Namespace: System.Data
Assembly: System.Data (in system.data.dll)
Syntax
'Declaration
Public Interface IDataParameter
'Usage
Dim instance As IDataParameter
public interface IDataParameter
public interface class IDataParameter
public interface IDataParameter
public interface IDataParameter
Hinweise
Die IDataParameter-Schnittstelle ermöglicht einer erbenden Klasse das Implementieren einer Parameter-Klasse, die einen Parameter für ein Command-Objekt darstellt. Weitere Informationen über Parameter-Klassen finden Sie unter Verwenden von gespeicherten Prozeduren mit einem Befehl. Weitere Informationen über das Implementieren von .NET Framework-Datenanbietern finden Sie unter Implementing a .NET Framework Data Provider.
Eine Anwendung erstellt eine Instanz der IDataParameter-Schnittstelle nicht direkt, sondern erstellt eine Instanz einer Klasse, die IDataParameter erbt.
Klassen, die IDataParameter erben, müssen die geerbten Member implementieren. Sie definieren i. d. R. zusätzliche Member, durch die anbieterspezifische Funktionen hinzugefügt werden. Die IDataParameter-Schnittstelle definiert z. B. die DbType-Eigenschaft. Die OleDbParameter-Klasse erbt wiederum diese Eigenschaft und definiert außerdem die OleDbType-Eigenschaft.
Hinweise für Implementierer Benennen Sie zur Förderung der Konsistenz unter den .NET Framework-Datenprovidern die erbende Klasse in der Form Prv Parameter, wobei Prv das einheitliche Präfix für alle Klassen in einem bestimmten Namespace von .NET Framework-Datenprovidern ist. Sql ist z. B. das Präfix der SqlCommand-Klasse im System.Data.SqlClient-Namespace. Wenn Sie die IDataParameter-Schnittstelle vererben, müssen 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 Parameter-Klasse mit dem Parameternamen und dem Datentyp. |
PrvParameter(string name, object value) |
Initialisiert eine neue Instanz der Parameter-Klasse mit dem Parameternamen und einem Objekt, das der Wert des Parameters ist. |
PrvParameter(string name, PrvDbType dataType, int size) |
Initialisiert eine neue Instanz der Parameter-Klasse 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 sowie dem Namen der Quellspalte. |
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, dem Datentyp, der Breite, dem Namen der Quellspalte, der Parameterrichtung, der numerischen Genauigkeit sowie anderen Eigenschaften. |
Beispiel
Im folgenden Beispiel werden über die SqlParameterCollection-Auflistung in SqlDataAdapter mehrere Instanzen der abgeleiteten Klasse SqlParameter erstellt. Mithilfe dieser Parameter werden Daten aus der Datenquelle ausgewählt und in der DataSet-Klasse platziert. In diesem Beispiel wird davon ausgegangen, dass bereits eine DataSet-Klasse und eine SqlDataAdapter-Klasse mit dem entsprechenden Schema, den entsprechenden Befehlen sowie der entsprechenden Verbindung erstellt wurden.
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
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);
}
Plattformen
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.
Versionsinformationen
.NET Framework
Unterstützt in: 2.0, 1.1, 1.0
.NET Compact Framework
Unterstützt in: 2.0, 1.0