SqlParameter クラス

定義

SqlCommandへのパラメーターと、必要に応じてDataSet列へのマッピングを表します。 このクラスは継承できません。 パラメーターの詳細については、「パラメーター とパラメーター データ型の構成」を参照してください。

public ref class SqlParameter sealed : MarshalByRefObject, ICloneable, System::Data::IDbDataParameter
public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))]
public sealed class SqlParameter : MarshalByRefObject, ICloneable, System.Data.IDbDataParameter
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))>]
type SqlParameter = class
    inherit MarshalByRefObject
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))>]
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits MarshalByRefObject
Implements ICloneable, IDbDataParameter
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
継承
SqlParameter
継承
属性
実装

次の例では、SqlDataAdapter内のSqlParameterCollection コレクションを通じてSqlParameterの複数のインスタンスを作成します。 これらのパラメーターは、データ ソースからデータを選択し、 DataSetにデータを配置するために使用されます。 この例では、適切なスキーマ、コマンド、接続を使用して、 DataSetSqlDataAdapter が既に作成されていることを前提としています。 パラメーターの使用に関する詳細と追加の例については、「 ADO.NET および パラメーターとパラメーター データ型の構成でデータを取得および変更する」を参照してください。

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

注釈

パラメーター名では大文字と小文字は区別されません。

Note

名前なし (序数とも呼ばれます) パラメーターは、.NET Framework Data Provider for SQL Server ではサポートされていません。

詳細については、パラメーターの使用方法を示す追加のサンプル コードと共に、「 コマンドとパラメーター」を参照してください。

コンストラクター

名前 説明
SqlParameter()

SqlParameter クラスの新しいインスタンスを初期化します。

SqlParameter(String, Object)

パラメーター名と新しいSqlParameterの値を使用する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)

パラメーター名、パラメーターの型、パラメーターの長さ、方向、有効桁数、スケール、ソース列の名前、DataRowVersion値の 1 つ、ソース列マッピングのブール値、SqlParameterの値、この XML インスタンスのスキーマ コレクションがあるデータベースの名前を使用するSqlParameter クラスの新しいインスタンスを初期化します。 この XML インスタンスのスキーマ コレクションがある所有リレーショナル スキーマと、このパラメーターのスキーマ コレクションの名前。

SqlParameter(String, SqlDbType, Int32, String)

パラメーター名、SqlDbType、サイズ、およびソース列名を使用するSqlParameter クラスの新しいインスタンスを初期化します。

SqlParameter(String, SqlDbType, Int32)

パラメーター名、SqlDbType、およびサイズを使用するSqlParameter クラスの新しいインスタンスを初期化します。

SqlParameter(String, SqlDbType)

パラメーター名とデータ型を使用する SqlParameter クラスの新しいインスタンスを初期化します。

プロパティ

名前 説明
CompareInfo

このパラメーターに対して文字列比較を実行する方法を定義する CompareInfo オブジェクトを取得または設定します。

DbType

パラメーターの SqlDbType を取得または設定します。

Direction

パラメーターが入力専用、出力専用、双方向、またはストアド プロシージャの戻り値パラメーターかどうかを示す値を取得または設定します。

ForceColumnEncryption

Always Encrypted を使用する場合は、パラメーターの暗号化を適用します。 パラメーターを暗号化する必要がないことをドライバーに通知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

Valueを読み込むときに使用するDataRowVersionを取得または設定します。

SqlDbType

パラメーターの SqlDbType を取得または設定します。

SqlValue

パラメーターの値を SQL 型として取得または設定します。

TypeName

テーブル値パラメーターの型名を取得または設定します。

UdtTypeName

ユーザー定義型をパラメーターとして表す string を取得または設定します。

Value

パラメーターの値を取得または設定します。

XmlSchemaCollectionDatabase

この XML インスタンスのスキーマ コレクションがあるデータベースの名前を取得します。

XmlSchemaCollectionName

この XML インスタンスのスキーマ コレクションの名前を取得します。

XmlSchemaCollectionOwningSchema

この XML インスタンスのスキーマ コレクションがある所有リレーショナル スキーマ。

メソッド

名前 説明
CreateObjRef(Type)

リモート オブジェクトとの通信に使用されるプロキシの生成に必要なすべての関連情報を含むオブジェクトを作成します。

(継承元 MarshalByRefObject)
Equals(Object)

指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetLifetimeService()

このインスタンスの有効期間ポリシーを制御する現在の有効期間サービス オブジェクトを取得します。

(継承元 MarshalByRefObject)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
InitializeLifetimeService()

このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。

(継承元 MarshalByRefObject)
MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
MemberwiseClone(Boolean)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。

(継承元 MarshalByRefObject)
ResetDbType()

この SqlParameterに関連付けられている型をリセットします。

ResetSqlDbType()

この SqlParameterに関連付けられている型をリセットします。

ToString()

ParameterNameを含む文字列を取得します。

明示的なインターフェイスの実装

名前 説明
ICloneable.Clone()

このメンバーの説明については、 Clone()を参照してください。

IDbDataParameter.Precision

数値パラメーターの有効桁数を示します。

(継承元 DbParameter)
IDbDataParameter.Scale

このメンバーの説明については、 Scaleを参照してください。

(継承元 DbParameter)

適用対象

こちらもご覧ください