IDataParameter Interface

Definição

Representa um parâmetro a um objeto de Comando e, como opção, seus mapeamentos para colunas DataSet e é implementado por provedores de dados .NET que acessam as fontes de dados.Represents a parameter to a Command object, and optionally, its mapping to DataSet columns; and is implemented by .NET data providers that access data sources.

public interface class IDataParameter
public interface IDataParameter
type IDataParameter = interface
Public Interface IDataParameter
Derivado

Exemplos

O exemplo a seguir cria várias instâncias da classe derivada, SqlParameter , por meio da SqlParameterCollection coleção dentro do SqlDataAdapter .The following example creates multiple instances of the derived class, SqlParameter, through the SqlParameterCollection collection within the SqlDataAdapter. Esses parâmetros são usados para selecionar dados da fonte de dados e colocá-los no DataSet .These parameters are used to select data from the data source and place the data in the DataSet. Este exemplo supõe que um DataSet e um SqlDataAdapter já tenham sido criados com o esquema, os comandos e a conexão apropriados.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  

Comentários

A IDataParameter interface permite que uma classe de herança implemente uma classe de parâmetro, que representa um parâmetro para um objeto de comando.The IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. Para obter mais informações sobre classes de parâmetro, consulte configurando parâmetros e tipos de dados de parâmetro.For more information about Parameter classes, see Configuring Parameters and Parameter Data Types.

Um aplicativo não cria uma instância da IDataParameter interface diretamente, mas cria uma instância de uma classe que herda IDataParameter .An application does not create an instance of the IDataParameter interface directly, but creates an instance of a class that inherits IDataParameter.

As classes que herdam IDataParameter devem implementar os membros herdados e normalmente definem membros adicionais para adicionar funcionalidade específica do provedor.Classes that inherit IDataParameter must implement the inherited members, and typically define additional members to add provider-specific functionality. Por exemplo, a IDataParameter interface define a DbType propriedade.For example, the IDataParameter interface defines the DbType property. Por sua vez, a OleDbParameter classe herda essa propriedade e também define a OleDbType propriedade.In turn, the OleDbParameter class inherits this property, and also defines the OleDbType property.

Notas aos Implementadores

Para promover a consistência entre .NET Framework provedores de dados, nomeie a classe herdada no Prv parâmetro Form, em que Prv é o prefixo uniforme fornecido a todas as classes em um namespace de provedor de dados .NET Framework específico.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. Por exemplo, Sql é o prefixo da SqlCommand classe no System.Data.SqlClient namespace.For example, Sql is the prefix of the SqlCommand class in the System.Data.SqlClient namespace.

Ao herdar da IDataParameter interface, você deve implementar os seguintes construtores:When you inherit from the IDataParameter interface, you should implement the following constructors:

ItemItem DescriçãoDescription
PrvParameter()PrvParameter() Inicializa uma nova instância da classe de parâmetro.Initializes a new instance of the Parameter class.
PrvParameter (nome da cadeia de caracteres, PrvDbType dataType)PrvParameter(string name, PrvDbType dataType) Inicializa uma nova instância da classe de parâmetro com o nome do parâmetro e o tipo de dados.Initializes a new instance of the Parameter class with the parameter name and data type.
PrvParameter (nome da cadeia de caracteres, valor do objeto)PrvParameter(string name, object value) Inicializa uma nova instância da classe de parâmetro com o nome do parâmetro e um objeto que é o valor do parâmetro.Initializes a new instance of the Parameter class with the parameter name and an object that is the value of the Parameter.
PrvParameter (nome da cadeia de caracteres, PrvDbType dataType, int size)PrvParameter(string name, PrvDbType dataType, int size) Inicializa uma nova instância da classe de parâmetro com o nome do parâmetro, o tipo de dados e a largura.Initializes a new instance of the Parameter class with the parameter name, data type, and width.
PrvParameter (String name, PrvDbType dataType, int size, string srcColumn)PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) Inicializa uma nova instância da classe DbParameter com o nome do parâmetro, o tipo de dados, a largura e o nome da coluna de origem.Initializes a new instance of the DbParameter class with the parameter name, data type, width, and source column name.
PrvParameter (cadeia de caracteres parameterName, PrvDbType dbType, tamanho int, direção de ParameterDirection, booliana IsNullable, precisão de byte, escala de bytes, Cadeia de caracteres srcColumn, DataRowVersion srcVersion, valor do objeto)PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value) Inicializa uma nova instância da OleDbParameter classe com o nome do parâmetro, o tipo de dados, a largura, o nome da coluna de origem, a direção do parâmetro, a precisão numérica e outras propriedades.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.

Propriedades

DbType

Obtém ou define o DbType do parâmetro.Gets or sets the DbType of the parameter.

Direction

Obtém ou define um valor que indica se o parâmetro é apenas de entrada, saída, bidirecional ou um parâmetro de valor retornado do procedimento armazenado.Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

IsNullable

Obtém um valor que indica se o parâmetro aceita valores nulos.Gets a value indicating whether the parameter accepts null values.

ParameterName

Obtém ou define o nome de IDataParameter.Gets or sets the name of the IDataParameter.

SourceColumn

Obtém ou define o nome da coluna de origem mapeada para o DataSet e usada para carregar ou retornar o 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

Obtém ou define o DataRowVersion a ser usado ao carregar Value.Gets or sets the DataRowVersion to use when loading Value.

Value

Obtém ou define o valor do parâmetro.Gets or sets the value of the parameter.

Aplica-se a