SqlParameter Classe

Definição

Representa um parâmetro para a SqlCommand e opcionalmente o seu mapeamento para DataSet colunas. Esta classe não pode ser herdada. Para mais informações sobre parâmetros, consulte Configuração de Parâmetros e Tipos de Dados de Parâmetros.

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
SqlParameter
Herança
Atributos
Implementações

Exemplos

O exemplo seguinte cria múltiplas instâncias de SqlParameter através da SqlParameterCollection coleção dentro do SqlDataAdapter. Estes parâmetros são usados para selecionar dados da fonte de dados e colocar os dados no DataSet. Este exemplo assume que a DataSet e a SqlDataAdapter já foram criados usando o esquema, comandos e ligação apropriados. Para mais informações e exemplos adicionais sobre o uso de parâmetros, consulte Recuperar e Modificar Dados em ADO.NET e Configurando Parâmetros e Tipos de Dados de Parâmetros.

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

Observações

Os nomes dos parâmetros não distinguem maiúsculas e minúsculas.

Note

Parâmetros sem nome, também chamados de ordinais, não são suportados pelo .NET Framework Data Provider for SQL Server.

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

Construtores

Name Description
SqlParameter()

Inicializa uma nova instância da SqlParameter classe.

SqlParameter(String, Object)

Inicializa uma nova instância da SqlParameter classe que utiliza 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 utiliza o nome do parâmetro, o tipo do parâmetro, o tamanho do parâmetro, a ParameterDirection, a precisão do parâmetro, a escala do parâmetro, a coluna de origem, a DataRowVersion a para 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 SqlParameter classe que usa o nome do 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 Booleano para mapeamento de colunas de origem, o valor de , SqlParametero nome da base de dados onde está localizada a coleção de esquemas desta instância XML, o esquema relacional proprietário onde está localizada a coleção de esquemas para esta instância XML, e o nome da coleção de esquemas para este parâmetro.

SqlParameter(String, SqlDbType, Int32, String)

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

SqlParameter(String, SqlDbType, Int32)

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

SqlParameter(String, SqlDbType)

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

Propriedades

Name Description
CompareInfo

Obtém ou define o CompareInfo objeto que define como as comparações de strings devem ser realizadas para este parâmetro.

DbType

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

Direction

Recebe ou define um valor que indica se o parâmetro é apenas de entrada, apenas saída, bidirecional ou um parâmetro de retorno de procedimento armazenado.

ForceColumnEncryption

Aplica a encriptação de um parâmetro ao usar o Always Encrypted. Se o SQL Server informar o driver de que o parâmetro não precisa de ser encriptado, a consulta que utiliza o parâmetro falhará. Esta propriedade oferece proteção adicional contra ataques de segurança que envolvam um SQL Server comprometido a fornecer metadados de encriptação 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 impede o envio ou a receção de um valor nulo ao executar um comando.

LocaleId

Obtém ou define o identificador local que determina as convenções e a língua para uma determinada região.

Offset

Obtém ou define o offset 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 o DataSet e usada para carregar ou devolver o Value.

SourceColumnNullMapping

Recebe ou define um valor que indica se a coluna de origem é anulável. Isto permite SqlCommandBuilder gerar corretamente instruções Update para colunas anuláveis.

SourceVersion

Obtém ou define o DataRowVersion para usar quando carregas 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 valores de tabela.

UdtTypeName

Obtém ou define a string que representa um tipo definido pelo utilizador como parâmetro.

Value

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

XmlSchemaCollectionDatabase

Obtém o nome da base de dados onde está localizada a coleção de esquemas para esta instância XML.

XmlSchemaCollectionName

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

XmlSchemaCollectionOwningSchema

O esquema relacional proprietário onde se encontra a coleção de esquemas para esta instância XML.

Métodos

Name Description
CreateObjRef(Type)

Cria um objeto que contém toda a informação relevante necessária para gerar um proxy usado para 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 função de hash predefinida.

(Herdado de Object)
GetLifetimeService()

Recupera o objeto de serviço de tempo de vida atual que controla a política de vida útil neste caso.

(Herdado de MarshalByRefObject)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
InitializeLifetimeService()

Obtém-se um objeto de serviço vitalício para controlar a apólice vitalícia neste caso.

(Herdado de MarshalByRefObject)
MemberwiseClone()

Cria uma cópia superficial do atual Object.

(Herdado de Object)
MemberwiseClone(Boolean)

Cria uma cópia superficial do objeto atual MarshalByRefObject .

(Herdado de MarshalByRefObject)
ResetDbType()

Reinicia o tipo associado a este SqlParameter.

ResetSqlDbType()

Reinicia o tipo associado a este SqlParameter.

ToString()

Obtém-se uma cadeia que contém o ParameterName.

Implementações de Interface Explícita

Name Description
ICloneable.Clone()

Para uma descrição deste elemento, veja Clone().

IDbDataParameter.Precision

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

(Herdado de DbParameter)
IDbDataParameter.Scale

Para uma descrição deste elemento, veja Scale.

(Herdado de DbParameter)

Aplica-se a

Ver também