IDataParameter Interface

Définition

Espace de noms:

System.Data

Assembly:

System.Data.Common.dll

Représente un paramètre associé à un objet Command et éventuellement son mappage avec les colonnes DataSet ; est implémenté par les fournisseurs de données .NET qui accèdent aux sources de données.

public interface class IDataParameter

public interface IDataParameter

type IDataParameter = interface

Public Interface IDataParameter

Dérivé

System.Data.Common.DbParameter

System.Data.EntityClient.EntityParameter

System.Data.IDbDataParameter

System.Data.Odbc.OdbcParameter

System.Data.OleDb.OleDbParameter

System.Data.OracleClient.OracleParameter

Exemples

L’exemple suivant crée plusieurs instances de la classe dérivée, SqlParameter, via la SqlParameterCollection collection dans le SqlDataAdapter. Ces paramètres sont utilisés pour sélectionner des données à partir de la source de données et placer les données dans le DataSet. Cet exemple 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

L’interface IDataParameter permet à une classe héritée d’implémenter une classe Parameter, qui représente un paramètre pour un objet Command. Pour plus d’informations sur les classes Parameter, consultez Configuration des paramètres et des types de données de paramètre.

Une application ne crée pas directement une instance de l’interface IDataParameter , mais crée une instance d’une classe qui hérite IDataParameterde .

Les classes qui héritent IDataParameter doivent implémenter les membres hérités et généralement définir des membres supplémentaires pour ajouter des fonctionnalités spécifiques au fournisseur. Par exemple, l’interface IDataParameter définit la DbType propriété . À son tour, la OleDbParameter classe hérite de cette propriété et définit également la OleDbType propriété .

Notes pour les responsables de l’implémentation

Pour promouvoir la cohérence entre les fournisseurs de données .NET Framework, nommez la classe héritée sous la forme Prv Paramètre où Prv est le préfixe uniforme donné à toutes les classes dans un espace de noms de fournisseur de données .NET Framework spécifique. Par exemple, Sql est le préfixe de la SqlCommand classe dans l’espace de System.Data.SqlClient noms .

Lorsque vous héritez de l’interface IDataParameter , vous devez implémenter les constructeurs suivants :

Élément	Description
PrvParameter()	Initialise une nouvelle instance de la classe Parameter.
PrvParameter(string name, PrvDbType dataType)	Initialise une nouvelle instance de la classe Parameter avec le nom et le type de données du paramètre.
PrvParameter(nom de chaîne, valeur de l’objet)	Initialise une nouvelle instance de la classe Parameter avec le nom du paramètre et un objet qui est la valeur du Paramètre.
PrvParameter(string name, PrvDbType dataType, int size)	Initialise une nouvelle instance de la classe Parameter avec le nom, le type de données et la largeur du paramètre.
PrvParameter(string name, PrvDbType dataType, int size, string srcColumn)	Initialise une nouvelle instance de la classe DbParameter avec le nom du paramètre, le type de données, la largeur et le nom de la colonne source.
PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte Scale, string srcColumn, DataRowVersion srcVersion, object value)	Initialise une nouvelle instance de la classe avec le nom du paramètre, le type de données, la largeur, le nom de colonne source, la direction du paramètre, la OleDbParameter précision numérique et d’autres propriétés.

Propriétés

DbType	Obtient ou définit le DbType du paramètre.
Direction	Obtient ou définit une valeur qui indique si le paramètre est un paramètre d'entrée uniquement, de sortie uniquement, bidirectionnel ou une valeur de retour d'une procédure stockée.
IsNullable	Obtient une valeur qui indique si le paramètre accepte les valeurs Null.
ParameterName	Obtient ou définit le nom de l'objet IDataParameter.
SourceColumn	Obtient ou définit le nom de la colonne source mappée sur DataSet et utilisée pour charger et retourner Value.
SourceVersion	Récupère ou définit le DataRowVersion à utiliser au chargement de Value.
Value	Obtient ou définit la valeur du paramètre.