SqlParameter 类

定义

命名空间:

System.Data.SqlClient

程序集:

System.Data.dll

表示参数到列 SqlCommand 的映射 DataSet （可选）。 此类不能被继承。 有关参数的详细信息，请参阅 配置参数和参数数据类型。

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable

[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable

[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))>]
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable

Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable

继承

Object

MarshalByRefObject

DbParameter

SqlParameter

属性

TypeConverterAttribute

实现

IDataParameter IDbDataParameter ICloneable

示例

以下示例在集合中创建SqlDataAdapter多个SqlParameter实例SqlParameterCollection。 这些参数用于从数据源中选择数据，并将数据放入其中 DataSet。 此示例假定已使用相应的架构、命令和连接创建 a DataSet 和 a SqlDataAdapter 。 有关使用参数的详细信息和其他示例，请参阅 ADO.NET 和 配置参数和参数数据类型。

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

注解

参数名称不区分大小写。

Note

.NET Framework Data Provider for SQL Server 不支持无名称（也称为序号）参数。

有关详细信息，以及演示如何使用参数的其他示例代码，请参阅 命令和参数。

构造函数

名称	说明
SqlParameter()	初始化 SqlParameter 类的新实例。
SqlParameter(String, Object)	初始化类的新实例，该实例 SqlParameter 使用参数名称和新 SqlParameter值。
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)	初始化使用参数名称、参数类型、参数大小、参数大小、ParameterDirection参数精度、参数小数位数、源列、DataRowVersion要使用的参数和参数值的新实例SqlParameter。
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object, String, String, String)	初始化类的新实例，该类 SqlParameter 使用参数名称、参数的类型、参数方向的长度、精度、刻度、源列的名称、值之一 DataRowVersion 、源列映射的布尔值、值的 SqlParameter布尔值、此 XML 实例的架构集合所在的数据库的名称、 拥有此 XML 实例的架构集合所在的关系架构，以及此参数的架构集合的名称。
SqlParameter(String, SqlDbType, Int32, String)	初始化使用参数名称、SqlDbType大小和源列名称的类的新实例SqlParameter。
SqlParameter(String, SqlDbType, Int32)	初始化使用参数名称、大小SqlDbType和大小的类的新实例SqlParameter。
SqlParameter(String, SqlDbType)	初始化使用参数名称和数据类型的 SqlParameter 类的新实例。

属性

名称	说明
CompareInfo	获取或设置定义 CompareInfo 应如何对此参数执行字符串比较的对象。
DbType	获取或设置 SqlDbType 参数。
Direction	获取或设置一个值，该值指示参数是仅输入、仅输出、双向还是存储过程返回值参数。
ForceColumnEncryption	使用 Always Encrypted 时强制加密参数。 如果SQL Server通知驱动程序参数不需要加密，则使用该参数的查询将失败。 此属性提供对涉及泄露的安全攻击的额外保护，SQL Server向客户端提供不正确的加密元数据，这可能会导致数据泄露。
IsNullable	获取或设置一个值，该值指示参数是否接受 null 值。 IsNullable 不用于验证参数的值，在执行命令时不会阻止发送或接收 null 值。
LocaleId	获取或设置确定特定区域的约定和语言的区域设置标识符。
Offset	获取或设置属性的 Value 偏移量。
ParameterName	获取或设置 . 的名称 SqlParameter。
Precision	获取或设置用于表示 Value 属性的最大位数。
Scale	获取或设置解析到的小 Value 数位数。
Size	获取或设置列中数据的最大大小（以字节为单位）。
SourceColumn	获取或设置映射到 DataSet 和用于加载或返回的 Value源列的名称。
SourceColumnNullMapping	获取或设置一个值，该值指示源列是否可为 null。 这允许 SqlCommandBuilder 为可为 null 的列正确生成 Update 语句。
SourceVersion	获取或设置 DataRowVersion 加载 Value时要使用的值。
SqlDbType	获取或设置 SqlDbType 参数。
SqlValue	获取或设置参数的值作为 SQL 类型。
TypeName	获取或设置表值参数的类型名称。
UdtTypeName	获取或设置一个 string 表示用户定义类型的参数。
Value	获取或设置参数的值。
XmlSchemaCollectionDatabase	获取此 XML 实例的架构集合所在的数据库的名称。
XmlSchemaCollectionName	获取此 XML 实例的架构集合的名称。
XmlSchemaCollectionOwningSchema	拥有此 XML 实例的架构集合所在的关系架构。

方法

名称	说明
CreateObjRef(Type)	创建一个对象，其中包含生成用于与远程对象通信的代理所需的所有相关信息。 (继承自 MarshalByRefObject)
Equals(Object)	确定指定的对象是否等于当前对象。 (继承自 Object)
GetHashCode()	用作默认哈希函数。 (继承自 Object)
GetLifetimeService()	检索控制此实例的生存期策略的当前生存期服务对象。 (继承自 MarshalByRefObject)
GetType()	获取当前实例的 Type。 (继承自 Object)
InitializeLifetimeService()	获取生存期服务对象来控制此实例的生存期策略。 (继承自 MarshalByRefObject)
MemberwiseClone()	创建当前 Object的浅表副本。 (继承自 Object)
MemberwiseClone(Boolean)	创建当前 MarshalByRefObject 对象的浅表副本。 (继承自 MarshalByRefObject)
ResetDbType()	重置与此 SqlParameter关联的类型。
ResetSqlDbType()	重置与此 SqlParameter关联的类型。
ToString()	获取一个包含 . 的 ParameterName字符串。

显式接口实现

名称	说明
ICloneable.Clone()	有关此成员的说明，请参阅 Clone()。
IDbDataParameter.Precision	指示数值参数的精度。 (继承自 DbParameter)
IDbDataParameter.Scale	有关此成员的说明，请参阅 Scale。 (继承自 DbParameter)

另请参阅

• SqlParameterCollection
• SqlCommand
• 命令和参数
• DataAdapter 参数
• SQL Server 和 ADO.NET
• ADO.NET 概述