IDataParameter IDataParameter IDataParameter IDataParameter Interface

Définition

Représente un paramètre associé à un objet de commande et éventuellement son mappage sur des colonnes DataSet et qui est implémenté par les fournisseurs de données .NET Framework qui accèdent aux sources de données.Represents a parameter to a Command object, and optionally, its mapping to DataSet columns; and is implemented by .NET Framework data providers that access data sources.

public interface class IDataParameter
public interface IDataParameter
type IDataParameter = interface
Public Interface IDataParameter
Dérivé

Exemples

L’exemple suivant crée plusieurs instances de la classe dérivée, SqlParameter, jusqu'à la SqlParameterCollection collection dans le SqlDataAdapter.The following example creates multiple instances of the derived class, SqlParameter, through the SqlParameterCollection collection within the SqlDataAdapter. Ces paramètres sont utilisés pour sélectionner des données à partir de la source de données et les placer dans le DataSet.These parameters are used to select data from the data source and place the data in the DataSet. Cet exemple suppose qu’un DataSet et un SqlDataAdapter ont déjà été créés avec le schéma approprié, commandes et la connexion.This example assumes that a DataSet and a SqlDataAdapter have already been created with the appropriate schema, commands, and connection.

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

Le IDataParameter interface permet à une classe qui hérite d’implémenter une classe de paramètre, qui représente un paramètre pour un objet de commande.The IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. Pour plus d’informations sur les classes de paramètres, consultez configuration des paramètres et Types de données de paramètre.For more information about Parameter classes, see Configuring Parameters and Parameter Data Types.

Une application ne crée pas une instance de la IDataParameter interface directement, mais crée une instance d’une classe qui hérite de IDataParameter.An application does not create an instance of the IDataParameter interface directly, but creates an instance of a class that inherits IDataParameter.

Les classes qui héritent IDataParameter doit implémenter les membres hérités et définissent généralement des membres supplémentaires pour ajouter des fonctionnalités spécifiques au fournisseur.Classes that inherit IDataParameter must implement the inherited members, and typically define additional members to add provider-specific functionality. Par exemple, le IDataParameter interface définit le DbType propriété.For example, the IDataParameter interface defines the DbType property. À son tour, le OleDbParameter classe hérite de cette propriété et définit également la OleDbType propriété.In turn, the OleDbParameter class inherits this property, and also defines the OleDbType property.

Notes pour les responsables de l’implémentation

Pour promouvoir la cohérence entre les fournisseurs de données .NET Framework, nommez la classe qui hérite sous la forme Prv paramètre où Prv est le préfixe uniforme affecté à toutes les classes dans un espace de noms de fournisseur de données .NET Framework spécifique.To promote consistency among .NET Framework data providers, name the inheriting class in the form Prv Parameter where Prv is the uniform prefix given to all classes in a specific .NET Framework data provider namespace. Par exemple, Sql est le préfixe de le SqlCommand classe dans le System.Data.SqlClient espace de noms.For example, Sql is the prefix of the SqlCommand class in the System.Data.SqlClient namespace.

Lorsque vous héritez de la IDataParameter interface, vous devez implémenter les constructeurs suivants :When you inherit from the IDataParameter interface, you should implement the following constructors:

ÉlémentItem Description Description
PrvParameter()PrvParameter() Initialise une nouvelle instance de la classe de paramètre.Initializes a new instance of the Parameter class.

PrvParameter (nom de la chaîne, le type de données PrvDbType)PrvParameter(string name, PrvDbType dataType) Initialise une nouvelle instance de la classe de paramètre avec le paramètre nom et type de données.Initializes a new instance of the Parameter class with the parameter name and data type.

PrvParameter (nom de la chaîne, valeur de l’objet)PrvParameter(string name, object value) Initialise une nouvelle instance de la classe de paramètre avec le nom du paramètre et un objet qui est la valeur du paramètre.Initializes a new instance of the Parameter class with the parameter name and an object that is the value of the Parameter.

PrvParameter (nom de la chaîne, PrvDbType dataType, taille d’int)PrvParameter(string name, PrvDbType dataType, int size) Initialise une nouvelle instance de la classe de paramètre avec le nom du paramètre, type de données et la largeur.Initializes a new instance of the Parameter class with the parameter name, data type, and width.

PrvParameter (nom de la chaîne, PrvDbType le type de données, taille d’entier, chaîne srcColumn)PrvParameter(string name, PrvDbType dataType, int size, string srcColumn) Initialise une nouvelle instance de la classe DbParameter avec le nom du paramètre de type de données, la largeur et nom de colonne source.Initializes a new instance of the DbParameter class with the parameter name, data type, width, and source column name.

PrvParameter (chaîne parameterName, PrvDbType dbType, taille d’int, ParameterDirection direction, isNullable booléenne, précision d’octet, Byte échelle, srcColumn de chaîne, DataRowVersion srcVersion, valeur de l’objet)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 OleDbParameter classe avec le nom du paramètre, type de données, la largeur, nom de colonne source, direction du paramètre, précision numérique et d’autres propriétés.Initializes a new instance of the OleDbParameter class with the parameter name, data type, width, source column name, parameter direction, numeric precision, and other properties.

Propriétés

DbType DbType DbType DbType

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

Direction Direction Direction 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.Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

IsNullable IsNullable IsNullable IsNullable

Obtient une valeur qui indique si le paramètre accepte les valeurs Null.Gets a value indicating whether the parameter accepts null values.

ParameterName ParameterName ParameterName ParameterName

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

SourceColumn SourceColumn SourceColumn SourceColumn

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

SourceVersion SourceVersion SourceVersion SourceVersion

Récupère ou définit le DataRowVersion à utiliser au chargement de Value.Gets or sets the DataRowVersion to use when loading Value.

Value Value Value Value

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

S’applique à