SqlParameter 類別

定義

命名空間:

Microsoft.Data.SqlClient

組件:

Microsoft.Data.SqlClient.dll

套件:

Microsoft.Data.SqlClient v5.2.0

代表 SqlCommand 的參數，並選擇性地代表其對於 DataSet 資料行的對應。 此類別無法獲得繼承。 如需參數的詳細資訊，請參閱 設定參數。

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

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

type SqlParameter = class
    inherit DbParameter
    interface IDataParameter
    interface IDbDataParameter
    interface ICloneable

Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable

繼承

DbParameter

SqlParameter

實作

IDataParameter IDbDataParameter ICloneable

範例

下列範例會在 內透過 SqlParameterCollection 集合建立 的 SqlDataAdapter 多個實例 SqlParameter 。 這些參數可用來從資料來源中選取資料，並將資料 DataSet 放入 中。 此範例假設 DataSet 已使用適當的架構、命令和連線來建立 和 SqlDataAdapter 。 如需使用參數的詳細資訊和其他範例，請參閱 擷取和修改 ADO.NET 和 設定參數中的資料。

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

    }
}

備註

參數名稱不區分大小寫。

注意

.NET Framework Data Provider for SQL Server不支援無名稱，也稱為序數參數。

如需詳細資訊，以及示範如何使用參數的其他範例程式碼，請參閱 命令和參數。

建構函式

SqlParameter()	初始化 SqlParameter 類別的新執行個體。
SqlParameter(String, Object)	初始化 SqlParameter 類別的新執行個體，這個執行個體會使用新 SqlParameter 的參數名稱和值。
SqlParameter(String, SqlDbType)	初始化 SqlParameter 類別的新執行個體，這個執行個體會使用參數名稱和資料類型。
SqlParameter(String, SqlDbType, Int32)	初始化 SqlParameter 類別的新執行個體，這個執行個體會使用參數名稱、SqlDbType 和此大小。
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)	初始化 SqlParameter 類別的新執行個體，這個執行個體會使用參數名稱、參數類型、參數大小、ParameterDirection、參數精確度、參數比例、來源資料行、要使用的 DataRowVersion 和參數值。
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object, String, String, String)	初始化 SqlParameter 類別的新執行個體，其使用參數名稱、參數類型、參數長度、方向、有效位數、小數位數、來源資料行名稱、DataRowVersion 值的其中一個、來源資料行對應的布林值、SqlParameter 的值、這個 XML 執行個體的結構描述集合所在的資料庫名稱、這個 XML 執行個體的結構描述集合所在的主控關聯式結構描述，以及這個參數的結構描述集合的名稱。
SqlParameter(String, SqlDbType, Int32, String)	初始化 SqlParameter 類別的新執行個體，這個執行個體會使用參數名稱、SqlDbType、大小和來源資料行名稱。

屬性

CompareInfo	取得或設定 CompareInfo 物件，其定義應當如何為這個參數執行字串比較。
DbType	取得或設定參數的 SqlDbType。
Direction	取得或設定值，以表示參數是僅限輸入、僅限輸出、雙向 (Bidirectional) 或預存程序 (Stored Procedure) 傳回值參數。
ForceColumnEncryption	使用 Always Encrypted 時，會強制加密參數。 如果 SQL Server 向驅動程式告知參數不需要加密，使用該參數的查詢就會失敗。 此屬性會針對受到安全性攻擊危害的 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 執行個體結構描述集合所在的主控關聯式結構描述。

方法

ResetDbType()	重設與此 SqlParameter 相關聯的類型。
ResetSqlDbType()	重設與此 SqlParameter 相關聯的類型。
ToString()	取得包含 ParameterName 的字串。

明確介面實作

ICloneable.Clone()

如需這個成員的說明，請參閱 Clone()。

另請參閱

• SqlParameterCollection
• SqlCommand