SqlParameterCollection 类

定义

命名空间:

System.Data.SqlClient

程序集:

System.Data.SqlClient.dll

包:

System.Data.SqlClient v4.8.6

表示与 SqlCommand 关联的参数的集合以及各个参数到 DataSet 中列的映射。 此类不能被继承。

public ref class SqlParameterCollection sealed : System::Data::Common::DbParameterCollection

public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection

type SqlParameterCollection = class
    inherit DbParameterCollection

Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection

继承

Object

DbParameterCollection

SqlParameterCollection

示例

以下示例通过 SqlParameterCollection 集合创建 的SqlParameter多个实例。 参数用于选择数据源中的数据并填充 DataSet。 此代码假定 DataSet 已使用适当的架构、命令和连接创建了 和 SqlDataAdapter 。

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

注解

如果命令包含即席 SQL 语句，而不是存储过程名称，则集合中的参数数必须等于命令文本中的参数占位符数，否则SQL Server引发错误。 使用存储过程时，必须提供存储过程中声明的所有参数，而不使用默认值。 使用默认值声明的参数是可选的。 这样，可以指定默认值以外的值。

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

属性

Count	返回一个整数，包含 SqlParameterCollection 中的元素数。 只读。
IsFixedSize	获取一个值，该值指示 SqlParameterCollection 是否具有固定大小。
IsReadOnly	获取一个值，该值指示 SqlParameterCollection 是否为只读。
IsSynchronized	指定是否同步集合。 (继承自 DbParameterCollection)
Item[Int32]	获取位于指定索引处的 SqlParameter。
Item[String]	获取具有指定名称的 SqlParameter。
SyncRoot	获取可用于同步对 SqlParameterCollection 的访问的对象。

方法

Add(Object)	将指定的 SqlParameter 对象添加到 SqlParameterCollection 中。
Add(SqlParameter)	将指定的 SqlParameter 对象添加到 SqlParameterCollection 中。
Add(String, SqlDbType)	在给定参数名称和数据类型时向 SqlParameter 中添加一个 SqlParameterCollection。
Add(String, SqlDbType, Int32)	将 SqlParameter 添加到 SqlParameterCollection 中（给定了指定的参数名、SqlDbType 和大小）。
Add(String, SqlDbType, Int32, String)	使用给定的参数名称、数据类型和列长度向 SqlParameter 中添加一个 SqlParameterCollection。
AddRange(Array)	向 SqlParameterCollection 的末尾添加一个值数组。
AddRange(SqlParameter[])	向 SqlParameter 的末尾添加一个 SqlParameterCollection 值数组。
AddWithValue(String, Object)	向 SqlParameterCollection 的末尾添加一个值。
Clear()	从 SqlParameter 中移除所有的 SqlParameterCollection 对象。
Contains(Object)	确定指定的 Object 是否在此 SqlParameterCollection 中。
Contains(SqlParameter)	确定指定的 SqlParameter 是否在此 SqlParameterCollection 中。
Contains(String)	确定指定的参数名是否在SqlParameterCollection。
CopyTo(Array, Int32)	将当前 SqlParameterCollection 的所有元素复制到指定的一维 Array 中，并以指定的目标 Array 索引位置作为复制到的起始位置。
CopyTo(SqlParameter[], Int32)	将当前 SqlParameterCollection 的所有元素复制到指定的 SqlParameterCollection 中，并以指定的目标索引位置作为复制到的起始位置。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetEnumerator()	返回循环访问 SqlParameterCollection 的枚举数。
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetParameter(Int32)	返回位于集合中指定索引处的 DbParameter 对象。 (继承自 DbParameterCollection)
GetParameter(String)	返回具有指定名称的 DbParameter 对象。 (继承自 DbParameterCollection)
GetType()	获取当前实例的 Type。 (继承自 Object)
IndexOf(Object)	获取指定的 Object 在集合中的位置。
IndexOf(SqlParameter)	获取指定的 SqlParameter 在集合中的位置。
IndexOf(String)	获取具有指定名称的指定 SqlParameter 的位置。
Insert(Int32, Object)	在 Object 中的指定索引处插入一个 SqlParameterCollection。
Insert(Int32, SqlParameter)	在 SqlParameter 中的指定索引处插入一个 SqlParameterCollection 对象。
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
Remove(Object)	从集合中移除指定的 SqlParameter。
Remove(SqlParameter)	从集合中移除指定的 SqlParameter。
RemoveAt(Int32)	从 SqlParameter 的指定索引处移除 SqlParameterCollection。
RemoveAt(String)	从 SqlParameter 中移除具有指定参数名称的 SqlParameterCollection。
SetParameter(Int32, DbParameter)	将指定索引处的 DbParameter 对象设置为新值。 (继承自 DbParameterCollection)
SetParameter(String, DbParameter)	将具有指定名称的 DbParameter 对象设置为新值。 (继承自 DbParameterCollection)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

扩展方法

另请参阅

• 命令和参数 (ADO.NET)
• DataAdapter 参数 (ADO.NET)
• 使用适用于 SQL Server 的 .NET Framework 数据提供程序
• ADO.NET 概述