SqlParameterCollection Classe

Definição

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Pacote:

System.Data.SqlClient v4.8.6

Representa uma coleção de parâmetros associados a um SqlCommand e seus respectivos mapeamentos para colunas em um DataSet. Essa classe não pode ser herdada.

public ref class SqlParameterCollection sealed : System::Data::Common::DbParameterCollection

public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection

type SqlParameterCollection = class
    inherit DbParameterCollection

Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection

Herança

Object

DbParameterCollection

SqlParameterCollection

Exemplos

O exemplo a seguir cria várias instâncias de SqlParameter por meio da SqlParameterCollection coleção. Os parâmetros são usados para selecionar dados dentro da fonte de dados e preencher o DataSet. Esse código pressupõe que um DataSet e um SqlDataAdapter já foram criados com o esquema, os comandos e a conexão apropriados.

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

Se o comando contiver uma instrução SQL ad hoc, em vez de um nome de procedimento armazenado, o número dos parâmetros na coleção deverá ser igual ao número de espaços reservados de parâmetro dentro do texto de comando ou SQL Server gerará um erro. Com um procedimento armazenado, todos os parâmetros declarados no procedimento armazenado sem um valor padrão devem ser fornecidos. Parâmetros declarados com um valor padrão são opcionais. Isso permite que você especifique um valor diferente do padrão.

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

Propriedades

Count	Retorna um inteiro que contém o número de argumentos no SqlParameterCollection. Somente leitura.
IsFixedSize	Obtém um valor que indica se o SqlParameterCollection tem um tamanho fixo.
IsReadOnly	Obtém um valor que indica se o SqlParameterCollection é somente leitura.
IsSynchronized	Especifica se a coleção é sincronizada. (Herdado de DbParameterCollection)
Item[Int32]	Obtém o SqlParameter no índice especificado.
Item[String]	Obtém o SqlParameter com o nome especificado.
SyncRoot	Obtém um objeto que pode ser usado para sincronizar o acesso ao SqlParameterCollection.

Métodos

Add(Object)	Adiciona o objeto SqlParameter especificado ao SqlParameterCollection.
Add(SqlParameter)	Adiciona o objeto SqlParameter especificado ao SqlParameterCollection.
Add(String, SqlDbType)	Adiciona um SqlParameter ao SqlParameterCollection, dado o nome do parâmetro o tipo de dados.
Add(String, SqlDbType, Int32)	Adiciona um SqlParameter ao SqlParameterCollection, dado o nome do parâmetro especificado, SqlDbType e tamanho.
Add(String, SqlDbType, Int32, String)	Adiciona um SqlParameter ao SqlParameterCollection com o nome do parâmetro, o tipo de dados e o comprimento da coluna.
AddRange(Array)	Adiciona uma matriz de valores ao final do SqlParameterCollection.
AddRange(SqlParameter[])	Adiciona uma matriz de valores SqlParameter ao final do SqlParameterCollection.
AddWithValue(String, Object)	Adiciona um valor ao final do SqlParameterCollection.
Clear()	Remove todos os objetos SqlParameter do SqlParameterCollection.
Contains(Object)	Determina se o Object especificado está neste SqlParameterCollection.
Contains(SqlParameter)	Determina se o SqlParameter especificado está neste SqlParameterCollection.
Contains(String)	Determina se o nome de parâmetro especificado está neste SqlParameterCollection.
CopyTo(Array, Int32)	Copia todos os elementos do SqlParameterCollection atual para o Array unidimensional especificado, começando no índice Array de destino especificado.
CopyTo(SqlParameter[], Int32)	Copia todos os elementos do SqlParameterCollection atual para o SqlParameterCollection especificado, começando no índice de destino especificado.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetEnumerator()	Retorna um enumerador que itera por meio de SqlParameterCollection.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetParameter(Int32)	Retorna o objeto DbParameter no índice especificado na coleção. (Herdado de DbParameterCollection)
GetParameter(String)	Retorna o objeto DbParameter com o nome especificado. (Herdado de DbParameterCollection)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IndexOf(Object)	Obtém o local do Object especificado na coleção.
IndexOf(SqlParameter)	Obtém o local do SqlParameter especificado na coleção.
IndexOf(String)	Obtém o local do SqlParameter especificado com o nome especificado.
Insert(Int32, Object)	Insere um Object no SqlParameterCollection no índice especificado.
Insert(Int32, SqlParameter)	Insere um objeto SqlParameter no SqlParameterCollection no índice especificado.
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
Remove(Object)	Remove o SqlParameter especificado da coleção.
Remove(SqlParameter)	Remove o SqlParameter especificado da coleção.
RemoveAt(Int32)	Remove o SqlParameter do SqlParameterCollection no índice especificado.
RemoveAt(String)	Remove o SqlParameter do SqlParameterCollection no nome de parâmetro especificado.
SetParameter(Int32, DbParameter)	Define o objeto DbParameter no índice especificado para um novo valor. (Herdado de DbParameterCollection)
SetParameter(String, DbParameter)	Define o objeto DbParameter com o nome especificado para um novo valor. (Herdado de DbParameterCollection)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Métodos de Extensão

Confira também

• Comandos e parâmetros (ADO.NET)
• Parâmetros DataAdapter (ADO.NET)
• Usando o provedor de dados .NET Framework para SQL Server
• Visão geral do ADO.NET