IDataParameter Schnittstelle

Definition

Stellt einen Parameter sowie optional dessen Zuordnung zu DataSet-Spalten für ein Command-Objekt dar und wird von .NET Framework-Datenanbietern implementiert, die auf Datenquellen zugreifen.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
Abgeleitet

Beispiele

Im folgenden Beispiel SqlParameterwerden über die SqlParameterCollection -Auflistung in SqlDataAdaptermehrere Instanzen der abgeleiteten-Klasse erstellt.The following example creates multiple instances of the derived class, SqlParameter, through the SqlParameterCollection collection within the SqlDataAdapter. Diese Parameter werden verwendet, um Daten aus der Datenquelle auszuwählen und die Daten in der DataSetzu platzieren.These parameters are used to select data from the data source and place the data in the DataSet. In diesem Beispiel wird davon DataSet ausgegangen, SqlDataAdapter dass ein und ein bereits mit dem entsprechenden Schema, den Befehlen und der Verbindung erstellt wurden.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  

Hinweise

Die IDataParameter -Schnittstelle ermöglicht es einer erbenden Klasse, eine Parameter Klasse zu implementieren, die einen Parameter für ein Command-Objekt darstellt.The IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. Weitere Informationen zu Parameter Klassen finden Sie unter Konfigurieren von Parametern und Parameter Datentypen.For more information about Parameter classes, see Configuring Parameters and Parameter Data Types.

Eine Anwendung erstellt nicht direkt eine Instanz der IDataParameter Schnittstelle, sondern erstellt eine Instanz einer Klasse, die erbt. IDataParameterAn application does not create an instance of the IDataParameter interface directly, but creates an instance of a class that inherits IDataParameter.

Klassen, die IDataParameter erben, müssen die geerbten Member implementieren und in der Regel zusätzliche Elemente definieren, um anbieterspezifische Funktionen hinzuzufügen.Classes that inherit IDataParameter must implement the inherited members, and typically define additional members to add provider-specific functionality. Die IDataParameter -Schnittstelle definiert z. DbType b. die-Eigenschaft.For example, the IDataParameter interface defines the DbType property. Wiederum erbt die OleDbParameter -Klasse diese Eigenschaft und definiert auch die OleDbType -Eigenschaft.In turn, the OleDbParameter class inherits this property, and also defines the OleDbType property.

Hinweise für Ausführende

Um die Konsistenz zwischen .NET Framework Datenanbietern zu fördern, benennen Sie die erbende Klasse Prv im Form Prv -Parameter, wobei das einheitliche Präfix ist, das für alle Klassen in einem bestimmten .NET Framework Datenanbieter-Namespace angegeben wird.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. Beispielsweise Sql ist das Präfix SqlCommand der-Klasse im System.Data.SqlClient -Namespace.For example, Sql is the prefix of the SqlCommand class in the System.Data.SqlClient namespace.

Wenn Sie von der IDataParameter -Schnittstelle erben, sollten Sie die folgenden Konstruktoren implementieren:When you inherit from the IDataParameter interface, you should implement the following constructors:

ElementItem BeschreibungDescription
PrvParameter()PrvParameter() Initialisiert eine neue Instanz der Parameter-Klasse.Initializes a new instance of the Parameter class.
Prvparameter (Zeichen folgen Name, PrvDbType DataType)PrvParameter(string name, PrvDbType dataType) Initialisiert eine neue Instanz der Parameter Klasse mit dem Parameternamen und dem Datentyp.Initializes a new instance of the Parameter class with the parameter name and data type.
Prvparameter (Zeichen folgen Name, Objektwert)PrvParameter(string name, object value) Initialisiert eine neue Instanz der Parameter Klasse mit dem Parameternamen und einem-Objekt, das den Wert des-Parameters ist.Initializes a new instance of the Parameter class with the parameter name and an object that is the value of the Parameter.
Prvparameter (Zeichen folgen Name, PrvDbType DataType, int size)PrvParameter(string name, PrvDbType dataType, int size) Initialisiert eine neue Instanz der Parameter Klasse mit dem Parameternamen, dem Datentyp und der Breite.Initializes a new instance of the Parameter class with the parameter name, data type, and width.
Prvparameter (Zeichen folgen Name, PrvDbType DataType, int Size, String srccolumn)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 Quell Spaltennamen.Initializes a new instance of the DbParameter class with the parameter name, data type, width, and source column name.
Prvparameter (String Parameter Name, PrvDbType DbType, int Size, ParameterDirection Direction, Boolean IsNullable, Byte Precision, Byte Scale, String srccolumn, DataRowVersion srcversion, Object value)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 Quell Spalte, der Parameter Richtung, der numerischen Genauigkeit und anderen Eigenschaften.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.

Eigenschaften

DbType

Ruft den DbType des Parameters ab oder legt ihn fest.Gets or sets the DbType of the parameter.

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.Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

IsNullable

Ruft einen Wert ab, der anzeigt, ob der Parameter NULL-Werte akzeptiert.Gets a value indicating whether the parameter accepts null values.

ParameterName

Ruft den Namen der IDataParameter ab oder legt diesen fest.Gets or sets the name of the IDataParameter.

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.Gets or sets the name of the source column that is mapped to the DataSet and used for loading or returning the Value.

SourceVersion

Ruft die DataRowVersion ab, die beim Laden von Value verwendet werden soll, oder legt diese fest.Gets or sets the DataRowVersion to use when loading Value.

Value

Ruft den Wert des Parameters ab oder legt diesen fest.Gets or sets the value of the parameter.

Gilt für: