DbParameter Class

.NET Framework 4

Represents a parameter to a DbCommand¹ and optionally, its mapping to a DataSet² column. For more information on parameters, see Configuring Parameters and Parameter Data Types (ADO.NET)³.

Inheritance Hierarchy

System.Object⁴
  System.MarshalByRefObject⁵
    System.Data.Common.DbParameter
      System.Data.EntityClient.EntityParameter⁶
      System.Data.Odbc.OdbcParameter⁷
      System.Data.OleDb.OleDbParameter⁸
      System.Data.OracleClient.OracleParameter⁹
      System.Data.SqlClient.SqlParameter¹⁰

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

Syntax

public abstract class DbParameter : MarshalByRefObject, 
	IDbDataParameter, IDataParameter

The DbParameter type exposes the following members.

Constructors

	Name	Description
	DbParameter¹²	Initializes a new instance of the DbParameter class.

Top

Properties

	Name	Description
	DbType¹³	Gets or sets the DbType¹⁴ of the parameter.
	Direction¹⁵	Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.
	IsNullable¹⁶	Gets or sets a value that indicates whether the parameter accepts null values.
	ParameterName¹⁷	Gets or sets the name of the DbParameter.
	Size¹⁸	Gets or sets the maximum size, in bytes, of the data within the column.
	SourceColumn¹⁹	Gets or sets the name of the source column mapped to the DataSet² and used for loading or returning the Value²⁰.
	SourceColumnNullMapping²¹	Sets or gets a value which indicates whether the source column is nullable. This allows DbCommandBuilder²² to correctly generate Update statements for nullable columns.
	SourceVersion²³	Gets or sets the DataRowVersion²⁴ to use when you load Value²⁰.
	Value²⁰	Gets or sets the value of the parameter.

Top

Methods

	Name	Description
	CreateObjRef²⁵	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject⁵.)
	Equals(Object)²⁶	Determines whether the specified Object⁴ is equal to the current Object⁴. (Inherited from Object⁴.)
	Finalize²⁷	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object⁴.)
	GetHashCode²⁸	Serves as a hash function for a particular type. (Inherited from Object⁴.)
	GetLifetimeService²⁹	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject⁵.)
	GetType³⁰	Gets the Type³¹ of the current instance. (Inherited from Object⁴.)
	InitializeLifetimeService³²	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject⁵.)
	MemberwiseClone()³³	Creates a shallow copy of the current Object⁴. (Inherited from Object⁴.)
	MemberwiseClone(Boolean)³⁴	Creates a shallow copy of the current MarshalByRefObject⁵ object. (Inherited from MarshalByRefObject⁵.)
	ResetDbType³⁵	Resets the DbType property to its original settings.
	ToString³⁶	Returns a string that represents the current object. (Inherited from Object⁴.)

Top

Explicit Interface Implementations

	Name	Description
	IDbDataParameter.Precision³⁷	Indicates the precision of numeric parameters.
	IDbDataParameter.Scale³⁸	For a description of this member, see IDbDataParameter.Scale³⁹.

Top

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements⁴⁰.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Data.Common Namespace¹¹

Other Resources

DbProviderFactories (ADO.NET)⁴¹

ADO.NET Managed Providers and DataSet Developer Center⁴²

Links Table

¹http://msdn.microsoft.com/en-us/library/system.data.common.dbcommand.aspx

²http://msdn.microsoft.com/en-us/library/system.data.dataset.aspx

³http://msdn.microsoft.com/en-us/library/yy6y35y8.aspx

⁴http://msdn.microsoft.com/en-us/library/system.object.aspx

⁵http://msdn.microsoft.com/en-us/library/system.marshalbyrefobject.aspx

⁶http://msdn.microsoft.com/en-us/library/system.data.entityclient.entityparameter.aspx

⁷http://msdn.microsoft.com/en-us/library/system.data.odbc.odbcparameter.aspx

⁸http://msdn.microsoft.com/en-us/library/system.data.oledb.oledbparameter.aspx

⁹http://msdn.microsoft.com/en-us/library/system.data.oracleclient.oracleparameter.aspx

¹⁰http://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlparameter.aspx

¹¹http://msdn.microsoft.com/en-us/library/system.data.common.aspx

¹²http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.dbparameter.aspx

¹³http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.dbtype.aspx

¹⁴http://msdn.microsoft.com/en-us/library/system.data.dbtype.aspx

¹⁵http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.direction.aspx

¹⁶http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.isnullable.aspx

¹⁷http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.parametername.aspx

¹⁸http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.size.aspx

¹⁹http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.sourcecolumn.aspx

²⁰http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.value.aspx

²¹http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.sourcecolumnnullmapping.aspx

²²http://msdn.microsoft.com/en-us/library/system.data.common.dbcommandbuilder.aspx

²³http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.sourceversion.aspx

²⁴http://msdn.microsoft.com/en-us/library/system.data.datarowversion.aspx

²⁵http://msdn.microsoft.com/en-us/library/system.marshalbyrefobject.createobjref.aspx

²⁶http://msdn.microsoft.com/en-us/library/bsc2ak47.aspx

²⁷http://msdn.microsoft.com/en-us/library/system.object.finalize.aspx

²⁸http://msdn.microsoft.com/en-us/library/system.object.gethashcode.aspx

²⁹http://msdn.microsoft.com/en-us/library/system.marshalbyrefobject.getlifetimeservice.aspx

³⁰http://msdn.microsoft.com/en-us/library/system.object.gettype.aspx

³¹http://msdn.microsoft.com/en-us/library/system.type.aspx

³²http://msdn.microsoft.com/en-us/library/system.marshalbyrefobject.initializelifetimeservice.aspx

³³http://msdn.microsoft.com/en-us/library/system.object.memberwiseclone.aspx

³⁴http://msdn.microsoft.com/en-us/library/ms131262.aspx

³⁵http://msdn.microsoft.com/en-us/library/system.data.common.dbparameter.resetdbtype.aspx

³⁶http://msdn.microsoft.com/en-us/library/system.object.tostring.aspx

³⁷http://msdn.microsoft.com/en-us/library/bb357455.aspx

³⁸http://msdn.microsoft.com/en-us/library/bb346921.aspx

³⁹http://msdn.microsoft.com/en-us/library/system.data.idbdataparameter.scale.aspx

⁴⁰http://msdn.microsoft.com/en-us/library/8z6watww.aspx

⁴¹http://msdn.microsoft.com/en-us/library/wda6c36e.aspx

⁴²http://go.microsoft.com/fwlink/?LinkId=217917

Community Content Add

FAQ