SqlParameter Classe

Définition

Représente un paramètre passé à un SqlCommand et, éventuellement, son mappage à des colonnes DataSet.Represents a parameter to a SqlCommand and optionally its mapping to DataSet columns. Cette classe ne peut pas être héritée.This class cannot be inherited. Pour plus d’informations sur les paramètres, consultez Configuration des paramètres et des types de données des paramètres.For more information on parameters, see Configuring Parameters and Parameter Data Types.

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
[System.ComponentModel.TypeConverter("System.Data.SqlClient.SqlParameter+SqlParameterConverter, System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))]
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter/SqlParameterConverter))]
[System.ComponentModel.TypeConverter("System.Data.SqlClient.SqlParameter+SqlParameterConverter, System.Data, Version=2.0.5.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
Héritage
SqlParameter
Attributs
Implémente

Exemples

L’exemple suivant crée plusieurs instances de SqlParameter par l’intermédiaire de la collection de SqlParameterCollection dans le SqlDataAdapter.The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection within the SqlDataAdapter. Ces paramètres sont utilisés pour sélectionner des données dans la source de données et les placer dans le DataSet.These parameters are used to select data from the data source and put the data in the DataSet. Cet exemple suppose qu’un DataSet et un SqlDataAdapter ont déjà été créés à l’aide du schéma, des commandes et de la connexion appropriés.This example assumes that a DataSet and a SqlDataAdapter have already been created by using the appropriate schema, commands, and connection. Pour plus d’informations et pour obtenir des exemples supplémentaires sur l’utilisation des paramètres, consultez extraction et modification de données dans ADO.net et Configuration des paramètres et des types de donnéesde paramètres.For more information and additional examples on using parameters, see Retrieving and Modifying Data in ADO.NET and Configuring Parameters and Parameter Data Types.

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

Quant aux noms de paramètres, ils ne respectent pas la casse.Parameter names are not case sensitive.

Notes

Sans nom, également appelé ordinal, les paramètres ne sont pas pris en charge par le Fournisseur de données .NET Framework pour SQL Server.Nameless, also called ordinal, parameters are not supported by the .NET Framework Data Provider for SQL Server.

Pour plus d’informations, ainsi que des exemples de code supplémentaires illustrant l’utilisation des paramètres, consultez commandes et paramètres.For more information, along with additional sample code demonstrating how to use parameters, see Commands and Parameters.

Constructeurs

SqlParameter()

Initialise une nouvelle instance de la classe SqlParameter.Initializes a new instance of the SqlParameter class.

SqlParameter(String, Object)

Initialise une nouvelle instance de la classe SqlParameter qui utilise le nom du paramètre et une valeur du nouveau SqlParameter.Initializes a new instance of the SqlParameter class that uses the parameter name and a value of the new SqlParameter.

SqlParameter(String, SqlDbType)

Initialise une nouvelle instance de la classe SqlParameter qui utilise le nom du paramètre et le type de données.Initializes a new instance of the SqlParameter class that uses the parameter name and the data type.

SqlParameter(String, SqlDbType, Int32)

Initialise une nouvelle instance de la classe SqlParameter qui utilise le nom du paramètre, le SqlDbType et la taille.Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, and the size.

SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)

Initialise une nouvelle instance de la classe SqlParameter qui utilise le nom du paramètre, le type du paramètre, la taille du paramètre, une ParameterDirection, la précision du paramètre, l’échelle du paramètre, la colonne source, une DataRowVersion à utiliser et la valeur du paramètre.Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the size of the parameter, a ParameterDirection, the precision of the parameter, the scale of the parameter, the source column, a DataRowVersion to use, and the value of the parameter.

SqlParameter(String, SqlDbType, Int32, String)

Initialise une nouvelle instance de la classe SqlParameter qui utilise le nom du paramètre, le SqlDbType, la taille et le nom de la colonne source.Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, the size, and the source column name.

SqlParameter(String, SqlDbType, String, String, String, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object)

Initialise une nouvelle instance de la classe SqlParameter qui utilise le nom du paramètre, le type du paramètre, la longueur du paramètre, la direction, la précision, l’échelle, le nom de la colonne source, l’une des valeurs de DataRowVersion, une valeur booléenne pour le mappage des colonnes sources, la valeur de SqlParameter, le nom de la base de données dans laquelle se trouve la collection de schémas pour cette instance XML, le schéma relationnel propriétaire dans lequel se trouve la collection de schémas pour cette instance XML et le nom de la collection de schémas pour ce paramètre.Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the length of the parameter the direction, the precision, the scale, the name of the source column, one of the DataRowVersion values, a Boolean for source column mapping, the value of the SqlParameter, the name of the database where the schema collection for this XML instance is located, the owning relational schema where the schema collection for this XML instance is located, and the name of the schema collection for this parameter.

Propriétés

CompareInfo

Obtient ou définit l’objet CompareInfo qui définit la façon dont les comparaisons de chaînes doivent être effectuées pour ce paramètre.Gets or sets the CompareInfo object that defines how string comparisons should be performed for this parameter.

DbType

Obtient ou définit le SqlDbType du paramètre.Gets or sets the SqlDbType of the parameter.

Direction

Obtient ou définit une valeur qui indique si le paramètre est réservé à l'entrée, réservé à la sortie, bidirectionnel ou bien s'il s'agit d'un paramètre de valeur de retour de la procédure stockée.Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

ForceColumnEncryption

Applique le chiffrement d’un paramètre lors de l’utilisation de la fonctionnalité Always Encrypted.Enforces encryption of a parameter when using Always Encrypted. Si SQL Server informe le pilote le paramètre n’a pas besoin d’être chiffré, la requête qui utilise ce paramètre échoue.If SQL Server informs the driver that the parameter does not need to be encrypted, the query using the parameter will fail. Cette propriété assure une protection supplémentaire contre les attaques de sécurité qui impliquent un serveur SQL Server compromis fournissant des métadonnées de chiffrement incorrectes au client, risquant d’entraîner une divulgation de données.This property provides additional protection against security attacks that involve a compromised SQL Server providing incorrect encryption metadata to the client, which may lead to data disclosure.

IsNullable

Obtient ou définit une valeur qui indique si le paramètre accepte les valeurs Null.Gets or sets a value that indicates whether the parameter accepts null values. IsNullable n’est pas utilisé pour valider la valeur du paramètre et n’empêche pas l’envoi ni la réception d’une valeur null durant l’exécution d’une commande.IsNullable is not used to validate the parameter's value and will not prevent sending or receiving a null value when executing a command.

LocaleId

Obtient ou définit l’identificateur de paramètres régionaux qui détermine les conventions et la langue pour une région particulière.Gets or sets the locale identifier that determines conventions and language for a particular region.

Offset

Obtient ou définit l’offset sur la propriété Value.Gets or sets the offset to the Value property.

ParameterName

Obtient ou définit le nom de l'objet SqlParameter.Gets or sets the name of the SqlParameter.

Precision

Obtient ou définit le nombre maximal de chiffres utilisés pour représenter la propriété Value.Gets or sets the maximum number of digits used to represent the Value property.

Scale

Obtient ou définit le nombre de décimales appliqué à la résolution de Value.Gets or sets the number of decimal places to which Value is resolved.

Size

Obtient ou définit la taille maximale, en octets, des données dans la colonne.Gets or sets the maximum size, in bytes, of the data within the column.

SourceColumn

Obtient ou définit le nom de la colonne source mappée à DataSet et utilisée pour charger et retourner ValueGets or sets the name of the source column mapped to the DataSet and used for loading or returning the Value

SourceColumnNullMapping

Obtient ou définit une valeur qui indique si la colonne source accepte la valeur Null.Gets or sets a value which indicates whether the source column is nullable. Ainsi, SqlCommandBuilder peut générer correctement des instructions Update pour les colonnes qui acceptent la valeur Null.This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.

SourceVersion

Obtient ou définit l'objet DataRowVersion à utiliser lorsque vous chargez Value.Gets or sets the DataRowVersion to use when you load Value

SqlDbType

Obtient ou définit le SqlDbType du paramètre.Gets or sets the SqlDbType of the parameter.

SqlValue

Obtient ou définit la valeur du paramètre sous forme de type SQL.Gets or sets the value of the parameter as an SQL type.

TypeName

Obtient ou définit le nom de type d’un paramètre table.Gets or sets the type name for a table-valued parameter.

UdtTypeName

Obtient ou définit une string qui représente un type défini par l’utilisateur en tant que paramètre.Gets or sets a string that represents a user-defined type as a parameter.

Value

Obtient ou définit la valeur du paramètre.Gets or sets the value of the parameter.

XmlSchemaCollectionDatabase

Obtient le nom de la base de données où se trouve la collection de schémas pour cette instance XML.Gets the name of the database where the schema collection for this XML instance is located.

XmlSchemaCollectionName

Obtient le nom de la collection de schémas pour cette instance XML.Gets the name of the schema collection for this XML instance.

XmlSchemaCollectionOwningSchema

Schéma relationnel propriétaire où se trouve la collection de schémas pour cette instance XML.The owning relational schema where the schema collection for this XML instance is located.

Méthodes

CreateObjRef(Type)

Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Hérité de MarshalByRefObject)
Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.Determines whether the specified object is equal to the current object.

(Hérité de Object)
GetHashCode()

Sert de fonction de hachage par défaut.Serves as the default hash function.

(Hérité de Object)
GetLifetimeService()

Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Hérité de MarshalByRefObject)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
InitializeLifetimeService()

Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance.Obtains a lifetime service object to control the lifetime policy for this instance.

(Hérité de MarshalByRefObject)
MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
MemberwiseClone(Boolean)

Crée une copie superficielle de l'objet MarshalByRefObject actuel.Creates a shallow copy of the current MarshalByRefObject object.

(Hérité de MarshalByRefObject)
ResetDbType()

Rétablit le type associé à cet objet SqlParameter.Resets the type associated with this SqlParameter.

ResetSqlDbType()

Rétablit le type associé à cet objet SqlParameter.Resets the type associated with this SqlParameter.

ToString()

Obtient une chaîne qui contient l'objet ParameterName.Gets a string that contains the ParameterName.

Implémentations d’interfaces explicites

ICloneable.Clone()

Pour obtenir une description de ce membre, consultez Clone().For a description of this member, see Clone().

S’applique à

Voir aussi