SqlParameter Classe

  • Referência

Definição

Namespace:
Microsoft.Data.SqlClient
Assembly:
Microsoft.Data.SqlClient.dll
Pacote:
Microsoft.Data.SqlClient v1.0.19269.1
Pacote:
Microsoft.Data.SqlClient v1.1.4
Pacote:
Microsoft.Data.SqlClient v2.0.1
Pacote:
Microsoft.Data.SqlClient v2.1.4
Pacote:
Microsoft.Data.SqlClient v3.0.1
Pacote:
Microsoft.Data.SqlClient v3.1.0
Pacote:
Microsoft.Data.SqlClient v4.0.1
Pacote:
Microsoft.Data.SqlClient v4.1.0
Pacote:
Microsoft.Data.SqlClient v5.0.0
Pacote:
Microsoft.Data.SqlClient v5.1.0
Pacote:
Microsoft.Data.SqlClient v5.2.0

Representa um parâmetro para um SqlCommand e, opcionalmente, o mapeamento para colunas DataSet. Essa classe não pode ser herdada. Para obter mais informações sobre parâmetros, consulte Configurando parâmetros.

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
[System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlParameter+SqlParameterConverter))]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlParameter+SqlParameterConverter))>]
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
type SqlParameter = class
    inherit DbParameter
    interface IDataParameter
    interface IDbDataParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
Herança
DbParameter
SqlParameter
Atributos
TypeConverterAttribute
Implementações
IDataParameter IDbDataParameter ICloneable

Exemplos

O exemplo a seguir cria várias instâncias de 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 usando o esquema, os comandos e a conexão apropriados. Para obter mais informações e exemplos adicionais sobre como usar parâmetros, consulte Recuperando e modificando dados em ADO.NET e Configurando parâmetros.

using Microsoft.Data.SqlClient;
using System.Xml;
using System.Data.Common;
using System.Windows.Forms;

public class Form1 : Form
{
    protected DataSet categoriesDataSet;
    protected DataGrid dataGrid1;
    protected SqlDataAdapter categoriesAdapter;


    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);

    }
}

Comentários

Os nomes de parâmetro não diferenciam maiúsculas de minúsculas.

Observação

Parâmetros sem nome, também chamados de ordinais, não são compatíveis com o provedor de dados .NET Framework para SQL Server.

Para obter mais informações, juntamente com código de exemplo adicional que demonstra como usar parâmetros, consulte Comandos e parâmetros.

Construtores

SqlParameter()

Inicializa uma nova instância da classe SqlParameter.
SqlParameter(String, Object)

Inicializa uma nova instância da classe SqlParameter que usa o nome do parâmetro e um valor do novo SqlParameter.
SqlParameter(String, SqlDbType)

Inicializa uma nova instância da classe SqlParameter que usa o nome do parâmetro e o tipo de dados.
SqlParameter(String, SqlDbType, Int32)

Inicializa uma nova instância da classe SqlParameter que usa o nome do parâmetro, o SqlDbType e o tamanho.
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)

Inicializa uma nova instância da classe SqlParameter que usa o nome do parâmetro, o tipo do parâmetro, o tamanho do parâmetro, um ParameterDirection, a precisão do parâmetro, a escala do parâmetro, a coluna de origem, um DataRowVersion a ser usado e o valor do parâmetro.
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object, String, String, String)

Inicializa uma nova instância da classe SqlParameter que usa o nome do parâmetro, o tipo do parâmetro, o tamanho do parâmetro, a direção, a precisão, a escala, o nome da coluna de origem, um dos valores DataRowVersion, um booliano para o mapeamento da coluna de origem, o valor do SqlParameter, o nome do banco de dados em que a coleção de esquemas dessa instância XML está localizada, o esquema relacional de propriedade em que a coleção de esquemas dessa instância XML está localizada e o nome da coleção de esquemas desse parâmetro.
SqlParameter(String, SqlDbType, Int32, String)

Inicializa uma nova instância da classe SqlParameter que usa o nome do parâmetro, o SqlDbType, o tamanho e o nome da coluna de origem.

Propriedades

CompareInfo

Obtém ou define o objeto CompareInfo que define como as comparações de cadeia de caracteres devem ser realizadas neste parâmetro.
DbType

Obtém ou define o SqlDbType 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.
ForceColumnEncryption

Impõe a criptografia de um parâmetro ao usar Always Encrypted. Se o SQL Server informar o driver que o parâmetro não precisa ser criptografado, a consulta que estiver o parâmetro falhará. Essa propriedade fornece proteção adicional contra ataques de segurança que envolvem um SQL Server comprometido fornecendo metadados de criptografia incorretos ao cliente, o que pode levar à divulgação de dados.
IsNullable

Obtém ou define um valor que indica se o parâmetro aceita valores nulos. IsNullable não é usado para validar o valor do parâmetro e não impedirá o envio nem o recebimento de um valor nulo ao executar um comando.
LocaleId

Obtém ou define o identificador de localidade que determina as convenções e o idioma para uma região específica.
Offset

Obtém ou define o deslocamento para a propriedade Value.
ParameterName

Obtém ou define o nome de SqlParameter.
Precision

Obtém ou define o número máximo de dígitos usados para representar a propriedade Value.
Scale

Obtém ou define o número de casas decimais para as quais o Value é resolvido.
Size

Obtém ou define o tamanho máximo, em bytes, dos dados da coluna.
SourceColumn

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

Define ou obtém um valor que indica se a coluna de origem permite valor nulo. Isso permite que SqlCommandBuilder gere corretamente instruções Update para colunas que permitem valor nulo.
SourceVersion

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

Obtém ou define o SqlDbType do parâmetro.
SqlValue

Obtém ou define o valor do parâmetro como um tipo SQL.
TypeName

Obtém ou define o nome do tipo para um parâmetro com valor de tabela.
UdtTypeName

Obtém ou define um string que representa um tipo definido pelo usuário como um parâmetro.
Value

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

Obtém o nome do banco de dados em que a coleção de esquemas dessa instância XML está localizada.
XmlSchemaCollectionName

Obtém o nome da coleção de esquemas desta instância XML.
XmlSchemaCollectionOwningSchema

O esquema relacional proprietário em que a coleção de esquemas dessa instância XML está localizada.

Métodos

ResetDbType()

Redefine o tipo associado a este SqlParameter.
ResetSqlDbType()

Redefine o tipo associado a este SqlParameter.
ToString()

Obtém uma cadeia de caracteres que contém o ParameterName.

Implantações explícitas de interface

ICloneable.Clone()

Para obter uma descrição desse membro, confira Clone().

Aplica-se a

Confira também