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

例

次の例では、 内の SqlParameter コレクションを通じて の複数の SqlParameterCollection インスタンスを作成します SqlDataAdapter。 これらのパラメーターは、データ ソースからデータを選択し、 にデータを配置するために使用されます DataSet。 この例では、 と SqlDataAdapter がDataSet、適切なスキーマ、コマンド、接続を使用して既に作成されていることを前提としています。 パラメーターの使用に関する詳細と追加の例については、「 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)	パラメーター名、SqlDbType、およびサイズを使用する 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 の値の 1 つ、ソース列マッピングのブール値、SqlParameter の値、この XML インスタンスのスキーマ コレクションがあるデータベースの名前、この XML インスタンスのスキーマ コレクションがある所有リレーショナル スキーマ、このパラメーターのスキーマ コレクションの名前です。
SqlParameter(String, SqlDbType, Int32, String)	パラメーター名、SqlDbType、サイズ、およびソース列名を使用する SqlParameter クラスの新しいインスタンスを初期化します。

プロパティ

CompareInfo	このパラメーターについての文字列比較を実行する方法を定義する CompareInfo オブジェクトを取得または設定します。
DbType	パラメーターの SqlDbType を取得または設定します。
Direction	パラメーターが入力専用、出力専用、双方向、またはストアド プロシージャの戻り値パラメーターのいずれであるかを示す値を取得または設定します。
ForceColumnEncryption	[常に暗号化] を使用する場合、パラメーターの暗号化を強制的に適用します。 パラメーターの暗号化が不要であることが 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