SqlParameterCollection Classe

Définition

Espace de noms:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Paquet:

System.Data.SqlClient v4.8.6

Représente une collection de paramètres associés à un SqlCommand et leurs mappages respectifs aux colonnes d’un DataSet. Cette classe ne peut pas être héritée.

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

Héritage

Object

DbParameterCollection

SqlParameterCollection

Exemples

L’exemple suivant crée plusieurs instances de SqlParameter via la SqlParameterCollection collection . Les paramètres sont utilisés pour sélectionner des données dans la source de données et remplir le DataSet. Ce code suppose qu’un DataSet et un SqlDataAdapter ont déjà été créés avec le schéma, les commandes et la connexion appropriés.

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

Remarques

Si la commande contient une instruction SQL ad hoc, par opposition à un nom de procédure stockée, le nombre de paramètres dans la collection doit être égal au nombre d’espaces réservés de paramètres dans le texte de la commande, ou SQL Server génère une erreur. Avec une procédure stockée, tous les paramètres déclarés dans la procédure stockée sans valeur par défaut doivent être fournis. Les paramètres déclarés avec une valeur par défaut sont facultatifs. Cela vous permet de spécifier une valeur autre que la valeur par défaut.

Pour plus d’informations avec un exemple de code supplémentaire montrant comment utiliser des paramètres, consultez Commandes et paramètres.

Propriétés

Count	Retourne un entier qui contient le nombre d'éléments dans SqlParameterCollection. Lecture seule.
IsFixedSize	Obtient une valeur qui indique si SqlParameterCollection est de taille fixe.
IsReadOnly	Obtient une valeur qui indique si l’objet SqlParameterCollection est en lecture seule.
IsSynchronized	Spécifie si la collection est synchronisée. (Hérité de DbParameterCollection)
Item[Int32]	Obtient l'objet SqlParameter à l'index spécifié.
Item[String]	Obtient l'objet SqlParameter portant le nom spécifié.
SyncRoot	Obtient un objet qui peut être utilisé pour synchroniser l’accès à SqlParameterCollection.

Méthodes

Add(Object)	Ajoute l'objet SqlParameter spécifié au SqlParameterCollection.
Add(SqlParameter)	Ajoute l'objet SqlParameter spécifié au SqlParameterCollection.
Add(String, SqlDbType)	Ajoute un objet SqlParameter à SqlParameterCollection en fonction du nom du paramètre et du type de données.
Add(String, SqlDbType, Int32)	Ajoute un SqlParameter à SqlParameterCollection, en fonction du nom de paramètre, du SqlDbType et de la taille spécifiés.
Add(String, SqlDbType, Int32, String)	Ajoute un objet SqlParameter à SqlParameterCollection avec le nom du paramètre, le type de données et la longueur de la colonne.
AddRange(Array)	Ajoute un tableau de valeurs à la fin de l'objet SqlParameterCollection.
AddRange(SqlParameter[])	Ajoute un tableau de valeurs SqlParameter à la fin de l'objet SqlParameterCollection.
AddWithValue(String, Object)	Ajoute une valeur à la fin de l'objet SqlParameterCollection.
Clear()	Supprime tous les objets SqlParameter de SqlParameterCollection.
Contains(Object)	Détermine si l'objet Object spécifié se trouve dans cet objet SqlParameterCollection.
Contains(SqlParameter)	Détermine si l'objet SqlParameter spécifié se trouve dans cet objet SqlParameterCollection.
Contains(String)	Détermine si le nom de paramètre spécifié se trouve dans cette SqlParameterCollection.
CopyTo(Array, Int32)	Copie tous les éléments de l'objet SqlParameterCollection actuel dans le Array unidimensionnel spécifié, à partir de l'index Array de destination spécifié.
CopyTo(SqlParameter[], Int32)	Copie tous les éléments de l'objet SqlParameterCollection actuel dans l'objet SqlParameterCollection spécifié à partir de l'index de destination donné.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetEnumerator()	Retourne un énumérateur qui itère au sein de SqlParameterCollection.
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetParameter(Int32)	Retourne l’objet DbParameter à l’index spécifié dans la collection. (Hérité de DbParameterCollection)
GetParameter(String)	Retourne l’objet DbParameter avec le nom spécifié. (Hérité de DbParameterCollection)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IndexOf(Object)	Obtient l'emplacement du Object spécifié dans la collection.
IndexOf(SqlParameter)	Obtient l'emplacement du SqlParameter spécifié dans la collection.
IndexOf(String)	Obtient l'emplacement de l'objet SqlParameter spécifié portant le nom donné.
Insert(Int32, Object)	Insère un objet Object dans SqlParameterCollection à l'index spécifié.
Insert(Int32, SqlParameter)	Insère un objet SqlParameter dans SqlParameterCollection à l'index spécifié.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
Remove(Object)	Supprime l’objet SqlParameter spécifié de la collection.
Remove(SqlParameter)	Supprime l’objet SqlParameter spécifié de la collection.
RemoveAt(Int32)	Supprime l'objet SqlParameter de l'objet SqlParameterCollection à l'index spécifié.
RemoveAt(String)	Supprime l'objet SqlParameter de l'objet SqlParameterCollection au niveau du nom de paramètre spécifié.
SetParameter(Int32, DbParameter)	Affecte une nouvelle valeur à l’objet DbParameter à l’index spécifié. (Hérité de DbParameterCollection)
SetParameter(String, DbParameter)	Affecte une nouvelle valeur à l’objet DbParameter portant le nom spécifié. (Hérité de DbParameterCollection)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Méthodes d’extension

Voir aussi

• Commandes et paramètres (ADO.NET)
• Paramètres DataAdapter (ADO.NET)
• Utilisation du fournisseur de données .NET Framework pour SQL Server
• Vue d'ensemble d’ADO.NET