IDataParameter Интерфейс

Определение

Пространство имен:

System.Data

Сборки:

netstandard.dll, System.Data.Common.dll

Исходный код:

IDataParameter.cs

Представляет параметр для объекта Command и, при необходимости, его сопоставление с DataSet столбцами и реализуется поставщиками данных .NET, которые обращаются к источникам данных.

public interface class IDataParameter

public interface IDataParameter

type IDataParameter = interface

Public Interface IDataParameter

Производный

System.Data.Common.DbParameter

System.Data.EntityClient.EntityParameter

System.Data.IDbDataParameter

System.Data.Odbc.OdbcParameter

System.Data.OleDb.OleDbParameter

System.Data.OracleClient.OracleParameter

Примеры

В следующем примере создается несколько экземпляров производного класса через SqlParameterколлекцию SqlParameterCollection в пределах.SqlDataAdapter Эти параметры используются для выбора данных из источника данных и размещения данных в них DataSet. В этом примере предполагается, что уже DataSet создано и SqlDataAdapter уже создано с соответствующей схемой, командами и подключением.

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

Комментарии

Интерфейс IDataParameter позволяет наследующим классу реализовать класс Parameter, представляющий параметр для объекта Command. Дополнительные сведения о классах параметров см. в разделе "Настройка параметров" и "Типы данных параметров".

Приложение не создает экземпляр IDataParameter интерфейса напрямую, но создает экземпляр класса, наследуемого IDataParameter.

Классы, наследуемые IDataParameter должны реализовывать наследуемые элементы и обычно определять дополнительные элементы для добавления функциональных возможностей для конкретного поставщика. Например, IDataParameter интерфейс определяет DbType свойство. В свою очередь, OleDbParameter класс наследует OleDbType это свойство, а также определяет свойство.

Примечания для тех, кто реализует этот метод

Чтобы повысить согласованность между поставщиками данных .NET Framework, назовите наследующий класс в параметре формы Prv , где Prv является универсальным префиксом, предоставленным всем классам в определенном пространстве имен поставщика данных .NET Framework. Например, Sql префикс SqlCommand класса в System.Data.SqlClient пространстве имен.

При наследовании от IDataParameter интерфейса следует реализовать следующие конструкторы:

Пункт	Описание
PrvParameter()	Инициализирует новый экземпляр класса Parameter.
PrvParameter(string name, PrvDbType dataType)	Инициализирует новый экземпляр класса Parameter с именем параметра и типом данных.
PrvParameter(string name, object value)	Инициализирует новый экземпляр класса Parameter с именем параметра и объектом, который является значением параметра.
PrvParameter(string name, PrvDbType dataType, int size)	Инициализирует новый экземпляр класса Parameter с именем параметра, типом данных и шириной.
PrvParameter(string name, PrvDbType dataType, int size, string srcColumn)	Инициализирует новый экземпляр класса DbParameter с именем параметра, типом данных, шириной и именем исходного столбца.
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, значение объекта)	Инициализирует новый экземпляр класса с именем параметра, типом данных, шириной, именем исходного столбца OleDbParameter , направлением параметров, числовой точностью и другими свойствами.

Свойства

Имя	Описание
DbType	Возвращает или задает DbType параметр.
Direction	Возвращает или задает значение, указывающее, является ли параметр возвращаемым значением только входных данных, только выходными данными, двунаправленным или хранимым параметром возвращаемого значения хранимой процедуры.
IsNullable	Возвращает значение, указывающее, принимает ли параметр значения NULL.
ParameterName	Возвращает или задает имя IDataParameterобъекта .
SourceColumn	Возвращает или задает имя исходного столбца, сопоставленного с DataSet и используемым для загрузки или возврата Value.
SourceVersion	Возвращает или задает значение, используемое при загрузке DataRowVersionValue.
Value	Возвращает или задает значение параметра.