SqlParameterCollection Classe

Definição

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 : MarshalByRefObject, System::Collections::IList, System::Data::IDataParameterCollection
public ref class SqlParameterCollection sealed : System::Data::Common::DbParameterCollection
[System.ComponentModel.ListBindable(false)]
public sealed class SqlParameterCollection : MarshalByRefObject, System.Collections.IList, System.Data.IDataParameterCollection
[System.ComponentModel.ListBindable(false)]
public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection
[<System.ComponentModel.ListBindable(false)>]
type SqlParameterCollection = class
    inherit MarshalByRefObject
    interface IDataParameterCollection
    interface IList
    interface ICollection
    interface IEnumerable
[<System.ComponentModel.ListBindable(false)>]
type SqlParameterCollection = class
    inherit DbParameterCollection
Public NotInheritable Class SqlParameterCollection
Inherits MarshalByRefObject
Implements IDataParameterCollection, IList
Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection
Herança
SqlParameterCollection
Herança
Atributos
Implementações

Exemplos

O exemplo a seguir cria várias instâncias por SqlParameter meio da SqlParameterCollection coleção. Os parâmetros são usados para selecionar dados na 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 oposição a 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

Nome Description
Count

Retorna um Inteiro que contém o número de elementos 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 valor é somente leitura.

IsSynchronized

Obtém um valor que indica se o SqlParameterCollection valor está sincronizado.

Item[Int32]

Obtém o SqlParameter índice especificado.

Item[String]

Obtém o SqlParameter nome com o nome especificado.

SyncRoot

Obtém um objeto que pode ser usado para sincronizar o acesso ao SqlParameterCollection.

Métodos

Nome Description
Add(Object)

Adiciona o objeto especificado SqlParameter ao SqlParameterCollection.

Add(SqlParameter)

Adiciona o objeto especificado SqlParameter ao SqlParameterCollection.

Add(String, Object)
Obsoleto.

Adiciona o objeto especificado SqlParameter ao SqlParameterCollection.

Add(String, SqlDbType, Int32, String)

Adiciona um SqlParameter ao nome do SqlParameterCollection parâmetro, ao tipo de dados e ao comprimento da coluna.

Add(String, SqlDbType, Int32)

Adiciona um SqlParameter ao SqlParameterCollection, dado o nome SqlDbType do parâmetro especificado e o tamanho.

Add(String, SqlDbType)

Adiciona um SqlParameter ao SqlParameterCollection nome do parâmetro fornecido e ao tipo de dados.

AddRange(Array)

Adiciona uma matriz de valores ao final do SqlParameterCollection.

AddRange(SqlParameter[])

Adiciona uma matriz de SqlParameter valores ao final do SqlParameterCollection.

AddWithValue(String, Object)

Adiciona um valor ao final do SqlParameterCollection.

Clear()

Remove todos os SqlParameter objetos do SqlParameterCollection.

Contains(Object)

Determina se o especificado Object está neste SqlParameterCollection.

Contains(SqlParameter)

Determina se o especificado SqlParameter está neste SqlParameterCollection.

Contains(String)

Determina se o nome do parâmetro especificado está neste SqlParameterCollection.

CopyTo(Array, Int32)

Copia todos os elementos da corrente SqlParameterCollection para a inicialização unidimensional Array especificada no índice de destino Array especificado.

CopyTo(SqlParameter[], Int32)

Copia todos os elementos da corrente SqlParameterCollection para o especificado SqlParameterCollection começando no índice de destino especificado.

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)
GetEnumerator()

Retorna um enumerador que itera por meio do SqlParameterCollection.

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)
GetParameter(Int32)

Retorna o DbParameter objeto no índice especificado na coleção.

(Herdado de DbParameterCollection)
GetParameter(String)

Retorna DbParameter o objeto 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 especificado Object na coleção.

IndexOf(SqlParameter)

Obtém o local do especificado SqlParameter na coleção.

IndexOf(String)

Obtém o local do especificado SqlParameter com o nome especificado.

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)
Insert(Int32, Object)

Insere um Object no SqlParameterCollection índice especificado.

Insert(Int32, SqlParameter)

Insere um SqlParameter objeto SqlParameterCollection no índice especificado.

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)
Remove(Object)

Remove o especificado SqlParameter da coleção.

Remove(SqlParameter)

Remove o especificado SqlParameter da coleção.

RemoveAt(Int32)

Remove o SqlParameter do SqlParameterCollection índice especificado.

RemoveAt(String)

Remove o SqlParameter nome do SqlParameterCollection parâmetro especificado.

SetParameter(Int32, DbParameter)

Define o DbParameter objeto no índice especificado como um novo valor.

(Herdado de DbParameterCollection)
SetParameter(String, DbParameter)

Define o DbParameter objeto com o nome especificado como um novo valor.

(Herdado de DbParameterCollection)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Implantações explícitas de interface

Nome Description
IDataParameterCollection.Item[String]

Obtém ou define o parâmetro no índice especificado.

(Herdado de DbParameterCollection)
IList.Item[Int32]

Obtém ou define o elemento no índice especificado.

(Herdado de DbParameterCollection)

Métodos de Extensão

Nome Description
AsParallel(IEnumerable)

Habilita a paralelização de uma consulta.

AsQueryable(IEnumerable)

Converte um IEnumerable em um IQueryable.

Cast<TResult>(IEnumerable)

Converte os elementos de um IEnumerable para o tipo especificado.

OfType<TResult>(IEnumerable)

Filtra os elementos de um IEnumerable com base em um tipo especificado.

Aplica-se a

Confira também