SqlParameter Class
Represents a parameter to a SqlCommand and optionally its mapping to DataSet columns. This class cannot be inherited. For more information on parameters, see Configuring Parameters and Parameter Data Types.
Assembly: System.Data (in System.Data.dll)
System.MarshalByRefObject
System.Data.Common.DbParameter
System.Data.SqlClient.SqlParameter
| Name | Description | |
|---|---|---|
![]() | SqlParameter() | Initializes a new instance of the SqlParameter class. |
![]() | SqlParameter(String, Object) | Initializes a new instance of the SqlParameter class that uses the parameter name and a value of the new SqlParameter. |
![]() | SqlParameter(String, SqlDbType) | Initializes a new instance of the SqlParameter class that uses the parameter name and the data type. |
![]() | SqlParameter(String, SqlDbType, Int32) | 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) | 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, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object, String, String, String) | 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. |
![]() | SqlParameter(String, SqlDbType, Int32, String) | Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, the size, and the source column name. |
| Name | Description | |
|---|---|---|
![]() | CompareInfo | Gets or sets the CompareInfo object that defines how string comparisons should be performed for this parameter. |
![]() | DbType | Gets or sets the SqlDbType of the parameter.(Overrides DbParameter.DbType.) |
![]() | Direction | Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.(Overrides DbParameter.Direction.) |
![]() | ForceColumnEncryption | Enforces encryption of a parameter when using Always Encrypted. If SQL Server informs the driver that the parameter does not need to be encrypted, the query using the parameter will fail. 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 | Gets or sets a value that indicates whether the parameter accepts null values. IsNullable is not used to validate the parameter’s value and will not prevent sending or receiving a null value when executing a command.(Overrides DbParameter.IsNullable.) |
![]() | LocaleId | Gets or sets the locale identifier that determines conventions and language for a particular region. |
![]() | Offset | Gets or sets the offset to the Value property. |
![]() | ParameterName | Gets or sets the name of the SqlParameter.(Overrides DbParameter.ParameterName.) |
![]() | Precision | Gets or sets the maximum number of digits used to represent the Value property. |
![]() | Scale | Gets or sets the number of decimal places to which Value is resolved. |
![]() | Size | Gets or sets the maximum size, in bytes, of the data within the column.(Overrides DbParameter.Size.) |
![]() | SourceColumn | Gets or sets the name of the source column mapped to the DataSet and used for loading or returning the Value(Overrides DbParameter.SourceColumn.) |
![]() | SourceColumnNullMapping | Sets or gets a value which indicates whether the source column is nullable. This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.(Overrides DbParameter.SourceColumnNullMapping.) |
![]() | SourceVersion | Gets or sets the DataRowVersion to use when you load Value(Overrides DbParameter.SourceVersion.) |
![]() | SqlDbType | Gets or sets the SqlDbType of the parameter. |
![]() | SqlValue | Gets or sets the value of the parameter as an SQL type. |
![]() | TypeName | Gets or sets the type name for a table-valued parameter. |
![]() | UdtTypeName | Gets or sets a string that represents a user-defined type as a parameter. |
![]() | Value | Gets or sets the value of the parameter.(Overrides DbParameter.Value.) |
![]() | XmlSchemaCollectionDatabase | Gets the name of the database where the schema collection for this XML instance is located. |
![]() | XmlSchemaCollectionName | Gets the name of the schema collection for this XML instance. |
![]() | XmlSchemaCollectionOwningSchema | The owning relational schema where the schema collection for this XML instance is located. |
| Name | Description | |
|---|---|---|
![]() | CreateObjRef(Type) | 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.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.) |
![]() | GetType() | |
![]() | InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.) |
![]() | ResetDbType() | Resets the type associated with this SqlParameter.(Overrides DbParameter.ResetDbType().) |
![]() | ResetSqlDbType() | Resets the type associated with this SqlParameter. |
![]() | ToString() | Gets a string that contains the ParameterName.(Overrides Object.ToString().) |
| Name | Description | |
|---|---|---|
![]() ![]() | ICloneable.Clone() | For a description of this member, see Clone. |
![]() ![]() | IDbDataParameter.Precision | Indicates the precision of numeric parameters.(Inherited from DbParameter.) |
![]() ![]() | IDbDataParameter.Scale | For a description of this member, see IDbDataParameter.Scale.(Inherited from DbParameter.) |
Parameter names are not case sensitive.
Note |
|---|
Nameless, also called ordinal, parameters are not supported by the .NET Framework Data Provider for SQL Server. |
For more information, along with additional sample code demonstrating how to use parameters, see Commands and Parameters.
The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection within the SqlDataAdapter. These parameters are used to select data from the data source and put the data in the DataSet. This example assumes that a DataSet and a SqlDataAdapter have already been created by using the appropriate schema, commands, and connection. 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 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
Available since 1.1
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.





