SqlParameter クラス

定義

SqlCommand に対するパラメーター、および必要に応じてその DataSet 列へのマッピングを表します。Represents a parameter to a SqlCommand and optionally its mapping to DataSet columns. このクラスは継承できません。This class cannot be inherited. パラメーターの詳細については、「パラメーターおよびパラメーター データ型の構成」を参照してください。For more information on parameters, see Configuring Parameters and Parameter Data Types.

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
[System.ComponentModel.TypeConverter("System.Data.SqlClient.SqlParameter+SqlParameterConverter, System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))]
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter/SqlParameterConverter))]
[System.ComponentModel.TypeConverter("System.Data.SqlClient.SqlParameter+SqlParameterConverter, System.Data, Version=2.0.5.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
継承
SqlParameter
属性
実装

次の例では、SqlDataAdapter内の SqlParameterCollection コレクションを使用して SqlParameter の複数のインスタンスを作成します。The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection within the SqlDataAdapter. これらのパラメーターは、データソースからデータを選択し、DataSetにデータを格納するために使用されます。These parameters are used to select data from the data source and put the data in the DataSet. この例では、DataSetSqlDataAdapter が、適切なスキーマ、コマンド、および接続を使用して既に作成されていることを前提としています。This example assumes that a DataSet and a SqlDataAdapter have already been created by using the appropriate schema, commands, and connection. パラメーターの使用方法の詳細とその他の例については、「 ADO.NET でのデータの取得と変更」および「パラメーターとパラメーターデータ型の構成」を参照してください。For more information and additional examples on using parameters, see Retrieving and Modifying Data in ADO.NET and Configuring Parameters and Parameter Data Types.

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  

注釈

パラメーター名では大文字と小文字が区別されません。Parameter names are not case sensitive.

注意

名前のない (序数とも呼ばれます) パラメーターは、SQL Server の .NET Framework Data Provider ではサポートされていません。Nameless, also called ordinal, parameters are not supported by the .NET Framework Data Provider for SQL Server.

パラメーターの使用方法を示す追加のサンプルコードと共に、詳細については、「コマンドとパラメーター」を参照してください。For more information, along with additional sample code demonstrating how to use parameters, see Commands and Parameters.

コンストラクター

SqlParameter()

SqlParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlParameter class.

SqlParameter(String, Object)

新しい SqlParameter のパラメーター名および値を使用する SqlParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlParameter class that uses the parameter name and a value of the new SqlParameter.

SqlParameter(String, SqlDbType)

指定されたパラメーター名およびデータ型を使用する SqlParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlParameter class that uses the parameter name and the data type.

SqlParameter(String, SqlDbType, Int32)

パラメーター名、SqlParameter、およびサイズを使用する SqlDbType クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, and the size.

SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)

パラメーター名、パラメーターの型、パラメーターのサイズ、SqlParameter、パラメーターの有効桁数、パラメーターの小数点以下桁数、ソース列、使用する ParameterDirection、およびパラメーターの値を使用する DataRowVersion クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the size of the parameter, a ParameterDirection, the precision of the parameter, the scale of the parameter, the source column, a DataRowVersion to use, and the value of the parameter.

SqlParameter(String, SqlDbType, Int32, String)

パラメーター名、SqlParameter、サイズ、およびソース列名を使用する SqlDbType クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, the size, and the source column name.

SqlParameter(String, SqlDbType, String, String, String, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object)

以下のものを使用する SqlParameter クラスの新しいインスタンスを初期化します。つまり、パラメーター名、パラメーターの型、パラメーターの長さ、方向、精度、位取り、ソース列の名前、DataRowVersion の値の 1 つ、ソース列マッピングのブール値、SqlParameter の値、この XML インスタンスのスキーマ コレクションがあるデータベースの名前、この XML インスタンスのスキーマ コレクションがある所有リレーショナル スキーマ、このパラメーターのスキーマ コレクションの名前です。Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the length of the parameter the direction, the precision, the scale, the name of the source column, one of the DataRowVersion values, a Boolean for source column mapping, the value of the SqlParameter, the name of the database where the schema collection for this XML instance is located, the owning relational schema where the schema collection for this XML instance is located, and the name of the schema collection for this parameter.

プロパティ

CompareInfo

このパラメーターについての文字列比較を実行する方法を定義する CompareInfo オブジェクトを取得または設定します。Gets or sets the CompareInfo object that defines how string comparisons should be performed for this parameter.

DbType

パラメーターの SqlDbType を取得または設定します。Gets or sets the SqlDbType of the parameter.

Direction

パラメーターが、入力専用、出力専用、入出力、またはストアド プロシージャの戻り値パラメーターのいずれであるかを示す値を取得または設定します。Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

ForceColumnEncryption

[常に暗号化] を使用する場合、パラメーターの暗号化を強制的に適用します。Enforces encryption of a parameter when using Always Encrypted. パラメーターの暗号化が不要であることが SQL Server からドライバーに通知された場合、このパラメーターを使用するクエリは失敗します。If SQL Server informs the driver that the parameter does not need to be encrypted, the query using the parameter will fail. クライアントに対して不正な暗号化メタデータを提供する危険な SQL Server が関係したセキュリティ攻撃を受けると、データ漏洩が引き起こされる可能性がありますが、このプロパティは、そのような攻撃に対する付加的な保護を提供します。This property provides additional protection against security attacks that involve a compromised SQL Server providing incorrect encryption metadata to the client, which may lead to data disclosure.

IsNullable

パラメーターが null 値を受け取るかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the parameter accepts null values. IsNullable は、パラメーターの値の検証には使用されないため、コマンドを実行するときに null 値の送信や受信を妨げません。IsNullable is not used to validate the parameter's value and will not prevent sending or receiving a null value when executing a command.

LocaleId

特定の地域の規約や言語を決定するロケール識別子を取得または設定します。Gets or sets the locale identifier that determines conventions and language for a particular region.

Offset

Value プロパティへのオフセットを取得または設定します。Gets or sets the offset to the Value property.

ParameterName

SqlParameter の名前を取得または設定します。Gets or sets the name of the SqlParameter.

Precision

Value プロパティを表すために使用する最大桁数を取得または設定します。Gets or sets the maximum number of digits used to represent the Value property.

Scale

Value が解決される、小数点以下の桁数を取得または設定します。Gets or sets the number of decimal places to which Value is resolved.

Size

列内のデータの最大サイズ (バイト) を取得または設定します。Gets or sets the maximum size, in bytes, of the data within the column.

SourceColumn

DataSet にマップされ、Value を読み込んだり返したりするために使用されるソース列の名前を取得または設定します。Gets or sets the name of the source column mapped to the DataSet and used for loading or returning the Value

SourceColumnNullMapping

ソース列で NULL 値が許容されるかどうかを示す値を取得または設定します。Gets or sets a value which indicates whether the source column is nullable. これにより、SqlCommandBuilder で null 許容列の Update ステートメントを正しく生成できます。This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.

SourceVersion

DataRowVersion を読み込むときに使用する Value を取得または設定します。Gets or sets the DataRowVersion to use when you load Value

SqlDbType

パラメーターの SqlDbType を取得または設定します。Gets or sets the SqlDbType of the parameter.

SqlValue

パラメーターの値を SQL 型として取得または設定します。Gets or sets the value of the parameter as an SQL type.

TypeName

テーブル値パラメーターの型名を取得または設定します。Gets or sets the type name for a table-valued parameter.

UdtTypeName

パラメーターとしてユーザー定義型を表す string を取得または設定します。Gets or sets a string that represents a user-defined type as a parameter.

Value

パラメーターの値を取得または設定します。Gets or sets the value of the parameter.

XmlSchemaCollectionDatabase

この XML インスタンスのスキーマ コレクションがあるデータベースの名前を取得します。Gets the name of the database where the schema collection for this XML instance is located.

XmlSchemaCollectionName

この XML インスタンスのスキーマ コレクションの名前を取得します。Gets the name of the schema collection for this XML instance.

XmlSchemaCollectionOwningSchema

この XML インスタンスのスキーマ コレクションがある、所有リレーショナル スキーマ。The owning relational schema where the schema collection for this XML instance is located.

メソッド

CreateObjRef(Type)

リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(継承元 MarshalByRefObject)
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetLifetimeService()

対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(継承元 MarshalByRefObject)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
InitializeLifetimeService()

このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。Obtains a lifetime service object to control the lifetime policy for this instance.

(継承元 MarshalByRefObject)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
MemberwiseClone(Boolean)

現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。Creates a shallow copy of the current MarshalByRefObject object.

(継承元 MarshalByRefObject)
ResetDbType()

この SqlParameter に関連付けられている型をリセットします。Resets the type associated with this SqlParameter.

ResetSqlDbType()

この SqlParameter に関連付けられている型をリセットします。Resets the type associated with this SqlParameter.

ToString()

ParameterName を表す文字列を取得します。Gets a string that contains the ParameterName.

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

ICloneable.Clone()

このメンバーの詳細については、「Clone()」をご覧ください。For a description of this member, see Clone().

適用対象

こちらもご覧ください