Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
IDataParameter Interface
Collapse the table of content
Expand the table of content

IDataParameter Interface

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.

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)

public interface IDataParameter

The IDataParameter interface allows an inheriting class to implement a Parameter class, which represents a parameter to a Command object. For more information about Parameter classes, see Configuring Parameters and Parameter Data Types (ADO.NET).

An application does not create an instance of the IDataParameter interface directly, but creates an instance of a class that inherits IDataParameter.

Classes that inherit IDataParameter must implement the inherited members, and typically define additional members to add provider-specific functionality. For example, the IDataParameter interface defines the DbType property. In turn, the OleDbParameter class inherits this property, and also defines the OleDbType property.

Notes to Implementers:

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. For example, Sql is the prefix of the SqlCommand class in the System.Data.SqlClient namespace.

When you inherit from the IDataParameter interface, you should implement the following constructors:




Initializes a new instance of the Parameter class.

PrvParameter(string name, PrvDbType dataType)

Initializes a new instance of the Parameter class with the parameter name and data type.

PrvParameter(string name, object value)

Initializes a new instance of the Parameter class with the parameter name and an object that is the value of the Parameter.

PrvParameter(string name, PrvDbType dataType, int size)

Initializes a new instance of the Parameter class with the parameter name, data type, and width.

PrvParameter(string name, PrvDbType dataType, int size, string srcColumn)

Initializes a new instance of the DbParameter class with the parameter name, data type, width, and source column name.

PrvParameter(string parameterName, PrvDbType dbType, int size, ParameterDirection direction, Boolean isNullable, Byte precision, Byte scale, string srcColumn, DataRowVersion srcVersion, object value)

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.

The following example creates multiple instances of the derived class, SqlParameter, through the SqlParameterCollection collection within the SqlDataAdapter. These parameters are used to select data from the data source and place the data in the DataSet. 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 
// ...

    "@CategoryName", SqlDbType.VarChar, 80).Value = "toasters";
    "@SerialNum", SqlDbType.Int).Value = 239;


Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

© 2015 Microsoft