IDataParameter Интерфейс

Определение

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

System.Data

Сборка:

System.Data.Common.dll

Представляет параметр, относящийся к объекту 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 Parameter, где Prv — это универсальный префикс, предоставленный всем классам в определенном пространстве имен поставщика данных платформа .NET Framework. Например, Sql является префиксом SqlCommand класса в System.Data.SqlClient пространстве имен .

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

Элемент	Описание
PrvParameter()	Инициализирует новый экземпляр класса Parameter.
PrvParameter(string name, PrvDbType dataType)	Инициализирует новый экземпляр класса Parameter с именем параметра и типом данных.
PrvParameter(имя строки, значение объекта)	Инициализирует новый экземпляр класса Parameter с именем параметра и объектом, который является значением 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, object value)	Инициализирует новый экземпляр класса с именем параметра, типом данных, шириной, именем исходного OleDbParameter столбца, направлением параметра, числовой точностью и другими свойствами.

Свойства

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