IDataParameter IDataParameter IDataParameter IDataParameter Interface

Определение

Представляет параметр, относящийся к объекту Command, и при необходимости его сопоставление со столбцами DataSet. Реализация осуществляется с помощью поставщиков данных .NET Framework, которые обращаются к источникам данных.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
Производный

Примеры

В следующем примере создается несколько экземпляров производного класса SqlParameterс SqlParameterCollection помощью коллекции в SqlDataAdapter.The following example creates multiple instances of the derived class, SqlParameter, through the SqlParameterCollection collection within the SqlDataAdapter. Эти параметры используются для выбора данных из источника данных и размещения данных в DataSet.These parameters are used to select data from the data source and place the data in the DataSet. В этом примере предполагается DataSet , что SqlDataAdapter объект и уже были созданы с соответствующей схемой, командами и соединением.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  

Комментарии

IDataParameter Интерфейс позволяет наследующему классу реализовать класс параметра, который представляет параметр для командного объекта.The IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. Дополнительные сведения о классах параметров см. в разделе Настройка параметров и типов данных параметров.For more information about Parameter classes, see Configuring Parameters and Parameter Data Types.

Приложение не создает экземпляр IDataParameter интерфейса напрямую, но создает экземпляр класса, который IDataParameterнаследует.An application does not create an instance of the IDataParameter interface directly, but creates an instance of a class that inherits IDataParameter.

Классы, наследующие IDataParameter , должны реализовывать унаследованные члены и, как правило, определяют дополнительные члены для добавления функций, зависящих от поставщика.Classes that inherit IDataParameter must implement the inherited members, and typically define additional members to add provider-specific functionality. Например, IDataParameter интерфейс DbType определяет свойство.For example, the IDataParameter interface defines the DbType property. В свою очередь, OleDbParameter класс наследует это свойство, а также OleDbType определяет свойство.In turn, the OleDbParameter class inherits this property, and also defines the OleDbType property.

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

Чтобы обеспечить согласованность между .NET Framework поставщиками данных, назовите класс-наследник в Prv параметре Prv Form, где — это универсальный префикс, присваиваемый всем классам в определенном пространстве имен поставщика данных .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. Например, Sql является префиксом SqlCommand класса в System.Data.SqlClient пространстве имен.For example, Sql is the prefix of the SqlCommand class in the System.Data.SqlClient namespace.

При наследовании от IDataParameter интерфейса необходимо реализовать следующие конструкторы:When you inherit from the IDataParameter interface, you should implement the following constructors:

ЭлементItem ОписаниеDescription
Првпараметер ()PrvParameter() Инициализирует новый экземпляр класса Parameter.Initializes a new instance of the Parameter class.
Првпараметер (имя строки, тип данных Првдбтипе)PrvParameter(string name, PrvDbType dataType) Инициализирует новый экземпляр класса Parameter с именем параметра и типом данных.Initializes a new instance of the Parameter class with the parameter name and data type.
Првпараметер (строковое имя, значение объекта)PrvParameter(string name, object value) Инициализирует новый экземпляр класса Parameter с именем параметра и объектом, который является значением параметра.Initializes a new instance of the Parameter class with the parameter name and an object that is the value of the Parameter.
Првпараметер (строковое имя, тип данных Првдбтипе, размер int)PrvParameter(string name, PrvDbType dataType, int size) Инициализирует новый экземпляр класса Parameter, используя имя параметра, тип данных и ширину.Initializes a new instance of the Parameter class with the parameter name, data type, and width.
Првпараметер (строковое имя, тип данных Првдбтипе, размер int, строка srcColumn)PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) Инициализирует новый экземпляр класса DbParameter, используя имя параметра, тип данных, ширину и имя исходного столбца.Initializes a new instance of the DbParameter class with the parameter name, data type, width, and source column name.
Првпараметер (строка parameterName, Првдбтипе dbType, размер int, Параметердиректион, логическое значение, null, точность байт, масштаб в байтах, строка srcColumn, DataRowVersion Сркверсион, значение объекта)PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value) Инициализирует новый экземпляр OleDbParameter класса с именем параметра, типом данных, шириной, именем исходного столбца, направлением параметра, числовой точностью и другими свойствами.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.

Свойства

DbType DbType DbType DbType

Возвращает или устанавливает тип DbType параметра.Gets or sets the DbType of the parameter.

Direction Direction Direction Direction

Возвращает или задает значение, определяющее, предназначен ли параметр только для ввода, только для вывода, является ли он двунаправленным или возвращается хранимой процедурой.Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

IsNullable IsNullable IsNullable IsNullable

Получает значение, определяющее, может ли параметр принимать значения null.Gets a value indicating whether the parameter accepts null values.

ParameterName ParameterName ParameterName ParameterName

Возвращает или задает имя таблицы для объекта IDataParameter.Gets or sets the name of the IDataParameter.

SourceColumn SourceColumn SourceColumn SourceColumn

Возвращает или задает имя исходного столбца, сопоставленного с DataSet и используемого для загрузки или возвращения значения 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 SourceVersion SourceVersion SourceVersion

Возвращает или задает значение DataRowVersion при загрузке Value.Gets or sets the DataRowVersion to use when loading Value.

Value Value Value Value

Возвращает или задает значение параметра.Gets or sets the value of the parameter.

Применяется к