IDataParameter Interfejs

Definicja

Reprezentuje parametr obiektu Command i opcjonalnie mapowanie na kolumny i jest implementowany przez dostawców danych platformy .NET, którzy uzyskują dostęp do DataSet źródeł danych.

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 , SqlParameterza pośrednictwem SqlParameterCollection kolekcji w obiekcie SqlDataAdapter. Te parametry służą do wybierania danych ze źródła danych i umieszczania danych w elemecie DataSet. W tym przykładzie założono, że element DataSet i SqlDataAdapter został już utworzony przy użyciu odpowiedniego schematu, poleceń i połączenia.

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

Interfejs IDataParameter umożliwia dziedziczonej klasie implementowanie klasy Parametr, która reprezentuje parametr do obiektu Command. Aby uzyskać więcej informacji na temat klas parametrów, zobacz Konfigurowanie parametrów i typów danych parametrów.

Aplikacja nie tworzy bezpośrednio wystąpienia interfejsu IDataParameter , ale tworzy wystąpienie klasy dziedziczonej przez klasę IDataParameter.

Klasy dziedziczone IDataParameter muszą implementować dziedziczone elementy członkowskie i zazwyczaj definiują dodatkowe elementy członkowskie w celu dodania funkcji specyficznych dla dostawcy. Na przykład IDataParameter interfejs definiuje DbType właściwość . Z kolei OleDbParameter klasa dziedziczy tę właściwość, a także definiuje OleDbType właściwość.

Uwagi dotyczące implementowania

Aby podwyższyć spójność wśród dostawców danych .NET Framework, nazwij klasę dziedziczą w postaci Prv Parametr, gdzie Prv jest jednolity prefiks nadany wszystkim klasom w określonej przestrzeni nazw dostawcy danych .NET Framework. Na przykład Sql jest prefiksem SqlCommand klasy w System.Data.SqlClient przestrzeni nazw.

Po dziedziczeniu z interfejsu IDataParameter należy zaimplementować następujące konstruktory:

Element Opis
PrvParameter() Inicjuje nowe wystąpienie klasy Parameter.
PrvParameter(nazwa ciągu, Typ danych PrvDbType) Inicjuje nowe wystąpienie klasy Parametr z nazwą parametru i typem danych.
PrvParameter(nazwa ciągu, wartość obiektu) Inicjuje nowe wystąpienie klasy Parametr z nazwą parametru i obiektem, który jest wartością parametru .
PrvParameter(nazwa ciągu, Typ danych PrvDbType, rozmiar int) Inicjuje nowe wystąpienie klasy Parametr z nazwą parametru, typem danych i szerokością.
PrvParameter(nazwa ciągu, Typ danych PrvDbType, rozmiar int, ciąg srcColumn) Inicjuje nowe wystąpienie klasy DbParameter o nazwie parametru, typie danych, szerokości i nazwie kolumny źródłowej.
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, wartość obiektu) 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.

Właściwości

DbType

Pobiera lub ustawia DbType parametr .

Direction

Pobiera lub ustawia wartość wskazującą, czy parametr jest parametrem tylko wejściowym, wyjściowym, dwukierunkowym lub parametrem zwracanej wartości procedury składowanej.

IsNullable

Pobiera wartość wskazującą, czy parametr akceptuje wartości null.

ParameterName

Pobiera lub ustawia nazwę elementu IDataParameter.

SourceColumn

Pobiera lub ustawia nazwę kolumny źródłowej mapowanej na element i używany do DataSet ładowania lub zwracania Valueelementu .

SourceVersion

Pobiera lub ustawia parametr DataRowVersion , który ma być używany podczas ładowania Value.

Value

Pobiera lub ustawia wartość parametru.

Dotyczy