IDataParameter Interfejs

Definicja

Reprezentuje parametr do obiektu polecenia, opcjonalnie jego mapowanie do DataSet kolumn i jest implementowany przez .NET Framework dostawców danych, którzy uzyskują dostęp do źródeł danych.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
Pochodne

Przykłady

Poniższy przykład tworzy wiele wystąpień klasy pochodnej, SqlParameter za pomocą SqlParameterCollection kolekcji w ramach SqlDataAdapter .The following example creates multiple instances of the derived class, SqlParameter, through the SqlParameterCollection collection within the SqlDataAdapter. Te parametry służą do wybierania danych ze źródła danych i umieszczania danych w DataSet .These parameters are used to select data from the data source and place the data in the DataSet. W tym przykładzie przyjęto założenie, że DataSet a i SqlDataAdapter zostały już utworzone z odpowiednimi schematami, poleceniami i połączeniem.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  

Uwagi

IDataParameterInterfejs umożliwia dziedziczenie klasy w celu zaimplementowania klasy parametrów, która reprezentuje parametr do obiektu polecenia.The IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. Aby uzyskać więcej informacji na temat klas parametrów, zobacz Konfigurowanie parametrów i typów danych parametrów.For more information about Parameter classes, see Configuring Parameters and Parameter Data Types.

Aplikacja nie tworzy wystąpienia IDataParameter interfejsu bezpośrednio, ale tworzy wystąpienie klasy, która dziedziczy IDataParameter .An application does not create an instance of the IDataParameter interface directly, but creates an instance of a class that inherits IDataParameter.

Klasy dziedziczące IDataParameter muszą implementować dziedziczone elementy członkowskie i zwykle definiują dodatkowe elementy członkowskie do dodawania funkcji specyficznych dla dostawcy.Classes that inherit IDataParameter must implement the inherited members, and typically define additional members to add provider-specific functionality. Na przykład IDataParameter Interfejs definiuje DbType Właściwość.For example, the IDataParameter interface defines the DbType property. Z kolei OleDbParameter Klasa dziedziczy tę właściwość, a także definiuje OleDbType Właściwość.In turn, the OleDbParameter class inherits this property, and also defines the OleDbType property.

Uwagi dotyczące implementowania

Aby podwyższyć poziom spójności między dostawcami danych .NET Framework, nadaj nazwę klasy dziedziczonej w Prv parametrze, gdzie Prv jest jednolite Prefiks określony dla wszystkich klas w określonej przestrzeni nazw dostawcy danych .NET Framework.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. Na przykład, Sql jest prefiksem SqlCommand klasy w System.Data.SqlClient przestrzeni nazw.For example, Sql is the prefix of the SqlCommand class in the System.Data.SqlClient namespace.

W przypadku dziedziczenia z IDataParameter interfejsu należy zaimplementować następujące konstruktory:When you inherit from the IDataParameter interface, you should implement the following constructors:

ElementItem OpisDescription
PrvParameter()PrvParameter() Inicjuje nowe wystąpienie klasy Parameter.Initializes a new instance of the Parameter class.
PrvParameter (Nazwa ciągu, PrvDbType typu danych)PrvParameter(string name, PrvDbType dataType) Inicjuje nowe wystąpienie klasy Parameter z nazwą parametru i typem danych.Initializes a new instance of the Parameter class with the parameter name and data type.
PrvParameter (Nazwa ciągu, wartość obiektu)PrvParameter(string name, object value) Inicjuje nowe wystąpienie klasy Parameter z nazwą parametru i obiektem, który jest wartością parametru.Initializes a new instance of the Parameter class with the parameter name and an object that is the value of the Parameter.
PrvParameter (Nazwa ciągu, PrvDbType, rozmiar int)PrvParameter(string name, PrvDbType dataType, int size) Inicjuje nowe wystąpienie klasy Parameter z nazwą parametru, typem danych i szerokością.Initializes a new instance of the Parameter class with the parameter name, data type, and width.
PrvParameter (Nazwa ciągu, PrvDbType, rozmiar int, ciąg srcColumn)PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) Inicjuje nowe wystąpienie klasy DbParameter z nazwą parametru, typem danych, szerokością i nazwą kolumny źródłowej.Initializes a new instance of the DbParameter class with the parameter name, data type, width, and source column name.
PrvParameter (String ParameterName, PrvDbType dbType, int size, ParameterDirection Direction, Boolean IsNullable IsNull, precyzja bajtów, skala bajtów, ciąg srcColumn, DataRowVersion srcVersion, wartość obiektu)PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value) Inicjuje nowe wystąpienie OleDbParameter klasy z nazwą parametru, typem danych, szerokością, nazwą kolumny źródłowej, kierunkiem parametru, dokładnością liczbową i innymi właściwościami.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.

Właściwości

DbType

Pobiera lub ustawia DbType parametr.Gets or sets the DbType of the parameter.

Direction

Pobiera lub ustawia wartość wskazującą, czy parametr jest tylko wejściowy, tylko wyjście, dwukierunkowa lub parametr wartości zwracanej procedury składowanej.Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

IsNullable

Pobiera wartość wskazującą, czy parametr akceptuje wartości null.Gets a value indicating whether the parameter accepts null values.

ParameterName

Pobiera lub ustawia nazwę IDataParameter .Gets or sets the name of the IDataParameter.

SourceColumn

Pobiera lub ustawia nazwę kolumny źródłowej, która jest mapowana na DataSet i użyta do załadowania lub zwrócenia Value .Gets or sets the name of the source column that is mapped to the DataSet and used for loading or returning the Value.

SourceVersion

Pobiera lub ustawia DataRowVersion do użycia podczas ładowania Value .Gets or sets the DataRowVersion to use when loading Value.

Value

Pobiera lub ustawia wartość parametru.Gets or sets the value of the parameter.

Dotyczy