SqlParameter Classe

  • Referência

Definição

Namespace:
System.Data.SqlClient
Assembly:
System.Data.SqlClient.dll
Assembly:
System.Data.dll
Assemblies:
netstandard.dll, System.Data.SqlClient.dll
Pacote:
System.Data.SqlClient v4.8.6

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 e tipos de dados de parâmetro.

public ref class SqlParameter sealed : System::Data::Common::DbParameter
public ref class SqlParameter sealed : MarshalByRefObject, ICloneable, System::Data::IDbDataParameter
public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
public sealed class SqlParameter : System.Data.Common.DbParameter
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))]
public sealed class SqlParameter : MarshalByRefObject, ICloneable, System.Data.IDbDataParameter
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
type SqlParameter = class
    inherit DbParameter
[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))>]
type SqlParameter = class
    inherit MarshalByRefObject
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))>]
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
type SqlParameter = class
    inherit DbParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits DbParameter
Public NotInheritable Class SqlParameter
Inherits MarshalByRefObject
Implements ICloneable, IDbDataParameter
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
Herança
Object
DbParameter
SqlParameter
Herança
Object
MarshalByRefObject
DbParameter
SqlParameter
Herança
Object
MarshalByRefObject
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 e tipos de dados de parâmetro.

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

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

Observação

Parâmetros ordinais, também chamados de ordinais, não são compatíveis com o Provedor de Dados do .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

Obtém ou define 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.
SourceVersion

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

(Herdado de DbParameter)
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

CreateObjRef(Type)

Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto.

(Herdado de MarshalByRefObject)
Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.

(Herdado de Object)
GetLifetimeService()
Obsoleto.

Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância.

(Herdado de MarshalByRefObject)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
InitializeLifetimeService()
Obsoleto.

Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância.

(Herdado de MarshalByRefObject)
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
MemberwiseClone(Boolean)

Cria uma cópia superficial do objeto MarshalByRefObject atual.

(Herdado de MarshalByRefObject)
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().
IDataParameter.SourceVersion

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

(Herdado de DbParameter)
IDbDataParameter.Precision

Indica a precisão de parâmetros numéricos.

(Herdado de DbParameter)
IDbDataParameter.Scale

Para obter uma descrição desse membro, confira Scale.

(Herdado de DbParameter)

Aplica-se a

Confira também