SqlParameter Classe

Definição

Namespace:

System.Data.SqlClient

Assembly:

System.Data.dll

Representa um parâmetro para um SqlCommand e, opcionalmente, seu mapeamento para DataSet colunas. 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.

Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable

[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable

[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))>]
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable

Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable

Herança

Object

MarshalByRefObject

DbParameter

SqlParameter

Atributos

TypeConverterAttribute

Implementações

IDataParameter IDbDataParameter ICloneable

Exemplos

O exemplo a seguir cria várias instâncias por SqlParameter 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 Recuperação e modificação de dados no ADO.NET e Configurar 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 de parâmetro não diferenciam maiúsculas de minúsculas.

Note

Parâmetros sem nome, 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

Nome	Description
SqlParameter()	Inicializa uma nova instância da classe SqlParameter. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SqlParameter(String, Object)	Inicializa uma nova instância da SqlParameter classe que usa o nome do parâmetro e um valor do novo SqlParameter. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)	Inicializa uma nova instância da SqlParameter classe que usa o nome do parâmetro, o tipo do parâmetro, o tamanho do parâmetro, uma ParameterDirectionprecisão do parâmetro, a escala do parâmetro, a coluna de origem, a DataRowVersion usar e o valor do parâmetro. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object, String, String, String)	Inicializa uma nova instância da classe que usa o nome do SqlParameter parâmetro, o tipo do parâmetro, o comprimento do parâmetro a direção, a precisão, a escala, o nome da coluna de origem, um dos DataRowVersion valores, um booliano para mapeamento de 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 proprietário em que a coleção de esquemas dessa instância XML está localizada e o nome da coleção de esquemas para esse parâmetro. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SqlParameter(String, SqlDbType, Int32, String)	Inicializa uma nova instância da SqlParameter classe que usa o nome do parâmetro, o SqlDbTypetamanho e o nome da coluna de origem. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SqlParameter(String, SqlDbType, Int32)	Inicializa uma nova instância da SqlParameter classe que usa o nome do parâmetro, o SqlDbTypee o tamanho. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SqlParameter(String, SqlDbType)	Inicializa uma nova instância da SqlParameter classe que usa o nome do parâmetro e o tipo de dados. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.

Propriedades

Nome	Description
CompareInfo	Obtém ou define o CompareInfo objeto que define como as comparações de cadeia de caracteres devem ser executadas para esse parâmetro. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
DbType	Obtém ou define o SqlDbType parâmetro. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
Direction	Obtém ou define um valor que indica se o parâmetro é somente entrada, somente saída, bidirecional ou um parâmetro de valor retornado de procedimento armazenado. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
ForceColumnEncryption	Impõe a criptografia de um parâmetro ao usar o Always Encrypted. Se SQL Server informar ao driver que o parâmetro não precisa ser criptografado, a consulta que usa 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 para o cliente, o que pode levar à divulgação de dados. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
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 ou o recebimento de um valor nulo ao executar um comando. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
LocaleId	Obtém ou define o identificador de localidade que determina convenções e idioma para uma determinada região. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
Offset	Obtém ou define o deslocamento para a Value propriedade. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
ParameterName	Obtém ou define o nome do SqlParameter. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
Precision	Obtém ou define o número máximo de dígitos usados para representar a Value propriedade. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
Scale	Obtém ou define o número de casas decimais para as quais Value é resolvido. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
Size	Obtém ou define o tamanho máximo, em bytes, dos dados dentro da coluna. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SourceColumn	Obtém ou define o nome da coluna de origem mapeada para a DataSet e usada para carregar ou retornar o Value. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SourceColumnNullMapping	Obtém ou define um valor que indica se a coluna de origem é anulável. Isso permite SqlCommandBuilder gerar corretamente instruções update para colunas anuláveis. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SourceVersion	Obtém ou define o DataRowVersion uso a ser usado quando você carrega Value. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SqlDbType	Obtém ou define o SqlDbType parâmetro. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
SqlValue	Obtém ou define o valor do parâmetro como um tipo SQL. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
TypeName	Obtém ou define o nome do tipo para um parâmetro com valor de tabela. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
UdtTypeName	Obtém ou define um string que representa um tipo definido pelo usuário como um parâmetro. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
Value	Obtém ou define o valor do parâmetro. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
XmlSchemaCollectionDatabase	Obtém o nome do banco de dados em que a coleção de esquemas dessa instância XML está localizada. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
XmlSchemaCollectionName	Obtém o nome da coleção de esquemas para esta instância XML. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
XmlSchemaCollectionOwningSchema	O esquema relacional proprietário em que a coleção de esquemas dessa instância XML está localizada. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.

Métodos

Nome	Description
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()	Recupera o objeto de serviço de tempo de vida atual que controla a política de tempo de vida para essa instância. (Herdado de MarshalByRefObject)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
InitializeLifetimeService()	Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida dessa instância. (Herdado de MarshalByRefObject)
MemberwiseClone()	Cria uma cópia superficial do Objectatual. (Herdado de Object)
MemberwiseClone(Boolean)	Cria uma cópia superficial do objeto atual MarshalByRefObject . (Herdado de MarshalByRefObject)
ResetDbType()	Redefine o tipo associado a isso SqlParameter. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
ResetSqlDbType()	Redefine o tipo associado a isso SqlParameter. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
ToString()	Obtém uma cadeia de caracteres que contém o ParameterName. Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.

Implantações explícitas de interface

Nome	Description
ICloneable.Clone()	Para obter uma descrição deste membro, consulte Clone(). Para um novo desenvolvimento, use Microsoft. Data.SqlClient. Esta página documenta System.Data.SqlClient.
IDbDataParameter.Precision	Indica a precisão dos parâmetros numéricos. (Herdado de DbParameter)
IDbDataParameter.Scale	Para obter uma descrição deste membro, consulte Scale. (Herdado de DbParameter)

Confira também

• SqlParameterCollection
• SqlCommand
• Comandos e parâmetros
• Parâmetros do DataAdapter
• SQL Server e ADO.NET
• Visão geral do ADO.NET