SqlParameterCollection 类

定义

命名空间:

Microsoft.Data.SqlClient

程序集:

Microsoft.Data.SqlClient.dll

包:

Microsoft.Data.SqlClient v5.2.0

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

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

[System.ComponentModel.ListBindable(false)]
public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection

[<System.ComponentModel.ListBindable(false)>]
type SqlParameterCollection = class
    inherit DbParameterCollection

Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection

继承

DbParameterCollection

SqlParameterCollection

属性

ListBindableAttribute

示例

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

using Microsoft.Data.SqlClient;
using System.Xml;
using System.Data.Common;
using System.Windows.Forms;

public class Form1 : Form
{
    protected DataSet categoriesDataSet;
    protected DataGrid dataGrid1;
    protected SqlDataAdapter categoriesAdapter;


    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);

    }
}

注解

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

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

属性

Count	返回一个整数，包含 SqlParameterCollection 中的元素数。 只读。
IsFixedSize	获取一个值，该值指示 SqlParameterCollection 是否具有固定大小。
IsReadOnly	获取一个值，该值指示 SqlParameterCollection 是否为只读。
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 中，并以指定的目标索引位置作为复制到的起始位置。
GetEnumerator()	返回循环访问 SqlParameterCollection 的枚举数。
IndexOf(Object)	获取指定的 Object 在集合中的位置。
IndexOf(SqlParameter)	获取指定的 SqlParameter 在集合中的位置。
IndexOf(String)	获取具有指定名称的指定 SqlParameter 的位置。
Insert(Int32, Object)	在 Object 中的指定索引处插入一个 SqlParameterCollection。
Insert(Int32, SqlParameter)	在 SqlParameter 中的指定索引处插入一个 SqlParameterCollection 对象。
Remove(Object)	从集合中移除指定的 SqlParameter。
Remove(SqlParameter)	从集合中移除指定的 SqlParameter。
RemoveAt(Int32)	从 SqlParameter 的指定索引处移除 SqlParameterCollection。
RemoveAt(String)	从 SqlParameter 中移除具有指定参数名称的 SqlParameterCollection。