SqlParameterCollection 類別

定義

命名空間:

System.Data.SqlClient

組件:

System.Data.dll

代表與 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

繼承

Object

MarshalByRefObject

DbParameterCollection

SqlParameterCollection

屬性

ListBindableAttribute

範例

下列範例會透過 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	取得值，表示 SqlParameterCollection 是否同步處理。
Item[Int32]	取得指定索引處的 SqlParameter。
Item[String]	取得具有指定名稱的 SqlParameter。
SyncRoot	取得可用以同步存取 SqlParameterCollection 的物件。

方法

Add(Object)	將指定的 SqlParameter 物件加入至 SqlParameterCollection。
Add(SqlParameter)	將指定的 SqlParameter 物件加入至 SqlParameterCollection。
Add(String, Object)	已淘汰. 將指定的 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，從指定的目的索引開始。
CreateObjRef(Type)	建立包含所有相關資訊的物件，這些資訊是產生用來與遠端物件通訊的所需 Proxy。 (繼承來源 MarshalByRefObject)
Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetEnumerator()	傳回在 SqlParameterCollection 中逐一查看的列舉值。
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetLifetimeService()	擷取控制這個執行個體存留期 (Lifetime) 原則的目前存留期服務物件。 (繼承來源 MarshalByRefObject)
GetParameter(Int32)	傳回位於此集合指定索引處的 DbParameter 物件。 (繼承來源 DbParameterCollection)
GetParameter(String)	傳回具有指定名稱的 DbParameter 物件。 (繼承來源 DbParameterCollection)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
IndexOf(Object)	取得集合中指定的 Object 位置。
IndexOf(SqlParameter)	取得集合中指定的 SqlParameter 位置。
IndexOf(String)	取得集合中具有指定名稱之指定 SqlParameter 的位置。
InitializeLifetimeService()	取得存留期服務物件，以控制這個執行個體的存留期原則。 (繼承來源 MarshalByRefObject)
Insert(Int32, Object)	將 Object 插入至 SqlParameterCollection 的指定索引處。
Insert(Int32, SqlParameter)	將 SqlParameter 物件插入 SqlParameterCollection 的指定索引處。
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
MemberwiseClone(Boolean)	建立目前 MarshalByRefObject 物件的淺層複本。 (繼承來源 MarshalByRefObject)
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)

明確介面實作

IDataParameterCollection.Item[String]	在指定索引位置上取得或設定參數。 (繼承來源 DbParameterCollection)
IList.Item[Int32]	在指定的索引位置上取得或設定項目。 (繼承來源 DbParameterCollection)

擴充方法

Cast<TResult>(IEnumerable)	將 IEnumerable 的項目轉換成指定的型別。
OfType<TResult>(IEnumerable)	根據指定的型別來篩選 IEnumerable 的項目。
AsParallel(IEnumerable)	啟用查詢的平行化作業。
AsQueryable(IEnumerable)	將 IEnumerable 轉換成 IQueryable。

另請參閱

• 命令和參數 (ADO.NET)
• DataAdapter 的參數 (ADO.NET)
• 使用 .NET Framework Data Provider for SQL Server
• ADO.NET 概觀 \(部分機器翻譯\)