IDataParameter Interface

  • Referência

Definição

Namespace:
System.Data
Assembly:
System.Data.Common.dll
Assembly:
System.Data.dll
Assembly:
netstandard.dll

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.

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. Esses parâmetros são usados para selecionar dados da fonte de dados e colocar os dados no DataSet. Este exemplo pressupõe que um DataSet e um SqlDataAdapter já foram criados com o esquema, os comandos e a conexão apropriados.

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 herdada implemente uma classe Parameter, que representa um parâmetro para um objeto Command. Para obter mais informações sobre classes parameter, consulte 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.

As classes herdadas IDataParameter devem implementar os membros herdados e, normalmente, definir membros adicionais para adicionar funcionalidade específica do provedor. Por exemplo, a IDataParameter interface define a DbType propriedade . Por sua vez, a OleDbParameter classe herda essa propriedade e também define a OleDbType propriedade .

Notas aos Implementadores

Para promover a consistência entre .NET Framework provedores de dados, nomeie a classe herdada no formato Prv Parâmetro, em que Prv é o prefixo uniforme fornecido a todas as classes em um namespace específico do provedor de dados .NET Framework. Por exemplo, Sql é o prefixo da SqlCommand classe no System.Data.SqlClient namespace .

Ao herdar da IDataParameter interface , você deve implementar os seguintes construtores:

Item Descrição
PrvParameter() Inicializa uma nova instância da classe Parameter.
PrvParameter(string name, PrvDbType dataType) Inicializa uma nova instância da classe Parameter com o nome do parâmetro e o tipo de dados.
PrvParameter(string name, object value) Inicializa uma nova instância da classe Parameter com o nome do parâmetro e um objeto que é o valor do Parâmetro.
PrvParameter(string name, PrvDbType dataType, int size) Inicializa uma nova instância da classe Parameter com o nome do parâmetro, o tipo de dados e a largura.
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.
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 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 OleDbParameter precisão numérica e outras propriedades.

Propriedades

DbType

Obtém ou define o DbType do parâmetro.
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.
IsNullable

Obtém um valor que indica se o parâmetro aceita valores nulos.
ParameterName

Obtém ou define o nome de IDataParameter.
SourceColumn

Obtém ou define o nome da coluna de origem mapeada para o DataSet e usada para carregar ou retornar o Value.
SourceVersion

Obtém ou define o DataRowVersion a ser usado ao carregar Value.
Value

Obtém ou define o valor do parâmetro.

Aplica-se a