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.

public ref class SqlParameter sealed : MarshalByRefObject, ICloneable, System::Data::IDbDataParameter
public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
[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
[<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
Public NotInheritable Class SqlParameter
Inherits MarshalByRefObject
Implements ICloneable, IDbDataParameter
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
Herança
Object
MarshalByRefObject
SqlParameter
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.
SqlParameter(String, Object)

Inicializa uma nova instância da SqlParameter classe que usa o nome do parâmetro e um valor do novo SqlParameter.
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.
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.
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.
SqlParameter(String, SqlDbType, Int32)

Inicializa uma nova instância da SqlParameter classe que usa o nome do parâmetro, o SqlDbTypee o tamanho.
SqlParameter(String, SqlDbType)

Inicializa uma nova instância da SqlParameter classe que usa o nome do parâmetro e o tipo de dados.

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.
DbType

Obtém ou define o SqlDbType parâmetro.
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.
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.
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.
LocaleId

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

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

Obtém ou define o nome do SqlParameter.
Precision

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

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

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

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

Obtém ou define o DataRowVersion uso a ser usado quando você carrega Value.
SqlDbType

Obtém ou define o SqlDbType 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 para esta instância XML.
XmlSchemaCollectionOwningSchema

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

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 hash predefinida.

(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.
ResetSqlDbType()

Redefine o tipo associado a isso SqlParameter.
ToString()

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

Implantações explícitas de interface

Nome Description
ICloneable.Clone()

Para obter uma descrição deste membro, consulte Clone().
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)

Aplica-se a

Confira também