SqlParameterCollection クラス

定義

SqlCommand に関連付けられたパラメーターと、DataSet 内の列に対するそれぞれのマッピング コレクションを表します。Represents a collection of parameters associated with a SqlCommand and their respective mappings to columns in a DataSet. このクラスは継承できません。This class cannot be inherited.

public ref class SqlParameterCollection sealed : System::Data::Common::DbParameterCollection, System::Collections::IList
[System.ComponentModel.ListBindable(false)]
public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection, System.Collections.IList
type SqlParameterCollection = class
    inherit DbParameterCollection
    interface IDataParameterCollection
    interface IList
    interface ICollection
    interface IEnumerable
Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection
Implements IList
継承
SqlParameterCollection
属性
実装

次の例では、SqlParameterCollection コレクションを使用して SqlParameter の複数のインスタンスを作成します。The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection. パラメーターを使用して、データソース内のデータを選択し、DataSetを設定します。The parameters are used to select data within the data source and populate the DataSet. このコードでは、適切なスキーマ、コマンド、および接続を使用して、DataSetSqlDataAdapter が既に作成されていることを前提としています。This code assumes that a DataSet and a SqlDataAdapter have already been created with the appropriate schema, commands, and connection.

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 エラーが発生します。If the command contains an ad hoc SQL statement, as opposed to a stored-procedure name, the number of the parameters in the collection must be equal to the number of parameter placeholders within the command text, or SQL Server raises an error. ストアドプロシージャでは、既定値を指定せずに、ストアドプロシージャで宣言されているすべてのパラメーターを指定する必要があります。With a stored procedure, all the parameters declared in the stored procedure without a default value must be provided. 既定値を使用して宣言されたパラメーターは省略可能です。Parameters declared with a default value are optional. これにより、既定値以外の値を指定できます。This lets you specify a value other than the default.

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

プロパティ

Count

SqlParameterCollection の要素数を格納している整数を返します。Returns an Integer that contains the number of elements in the SqlParameterCollection. 読み取り専用。Read-only.

IsFixedSize

SqlParameterCollection が固定サイズかどうかを示す値を取得します。Gets a value that indicates whether the SqlParameterCollection has a fixed size.

IsReadOnly

SqlParameterCollection が読み取り専用かどうかを示す値を取得します。Gets a value that indicates whether the SqlParameterCollection is read-only.

IsSynchronized

SqlParameterCollection が同期されているかどうかを示す値を取得します。Gets a value that indicates whether the SqlParameterCollection is synchronized.

Item[Int32]

指定されたインデックス位置にある SqlParameter を取得します。Gets the SqlParameter at the specified index.

Item[String]

指定された名前を持つ SqlParameter を取得します。Gets the SqlParameter with the specified name.

SyncRoot

SqlParameterCollection へのアクセスを同期するために使用できるオブジェクトを取得します。Gets an object that can be used to synchronize access to the SqlParameterCollection.

メソッド

Add(Object)

指定された SqlParameter オブジェクトを SqlParameterCollection に追加します。Adds the specified SqlParameter object to the SqlParameterCollection.

Add(SqlParameter)

指定された SqlParameter オブジェクトを SqlParameterCollection に追加します。Adds the specified SqlParameter object to the SqlParameterCollection.

Add(String, Object)

指定された SqlParameter オブジェクトを SqlParameterCollection に追加します。Adds the specified SqlParameter object to the SqlParameterCollection.

Add(String, SqlDbType)

指定されたパラメーター名とデータ型を持つ SqlParameterSqlParameterCollection に追加します。Adds a SqlParameter to the SqlParameterCollection given the parameter name and the data type.

Add(String, SqlDbType, Int32)

パラメーター名、SqlParameter、およびサイズを指定して、SqlParameterCollectionSqlDbType に追加します。Adds a SqlParameter to the SqlParameterCollection, given the specified parameter name, SqlDbType and size.

Add(String, SqlDbType, Int32, String)

指定されたパラメーター名、データ型、および列長を持つ SqlParameterSqlParameterCollection に追加します。Adds a SqlParameter to the SqlParameterCollection with the parameter name, the data type, and the column length.

AddRange(Array)

値の配列を SqlParameterCollection の末尾に追加します。Adds an array of values to the end of the SqlParameterCollection.

AddRange(SqlParameter[])

SqlParameter 値の配列を SqlParameterCollection の末尾に追加します。Adds an array of SqlParameter values to the end of the SqlParameterCollection.

AddWithValue(String, Object)

値を SqlParameterCollection の末尾に追加します。Adds a value to the end of the SqlParameterCollection.

Clear()

SqlParameter からすべての SqlParameterCollection オブジェクトを削除します。Removes all the SqlParameter objects from the SqlParameterCollection.

Contains(Object)

指定された Object がこの SqlParameterCollection に含まれているかどうかを調べます。Determines whether the specified Object is in this SqlParameterCollection.

Contains(SqlParameter)

指定された SqlParameter がこの SqlParameterCollection に含まれているかどうかを調べます。Determines whether the specified SqlParameter is in this SqlParameterCollection.

Contains(String)

指定したパラメーター名がこの SqlParameterCollection にあるかどうかを確認します。Determines whether the specified parameter name is in this SqlParameterCollection.

CopyTo(Array, Int32)

指定された 1 次元 SqlParameterCollection に現在の Array のすべての要素をコピーします。その際、指定されたコピー先の Array インデックス位置からコピーを開始します。Copies all the elements of the current SqlParameterCollection to the specified one-dimensional Array starting at the specified destination Array index.

CopyTo(SqlParameter[], Int32)

指定された SqlParameterCollection に現在の SqlParameterCollection のすべての要素をコピーします。その際、指定されたコピー先のインデックス位置からコピーを開始します。Copies all the elements of the current SqlParameterCollection to the specified SqlParameterCollection starting at the specified destination index.

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)
GetEnumerator()

SqlParameterCollection を反復処理する列挙子を返します。Returns an enumerator that iterates through the SqlParameterCollection.

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)
IndexOf(Object)

指定した Object のコレクション内での位置を取得します。Gets the location of the specified Object within the collection.

IndexOf(SqlParameter)

指定した SqlParameter のコレクション内での位置を取得します。Gets the location of the specified SqlParameter within the collection.

IndexOf(String)

指定された名前を持つ指定された SqlParameter の場所を取得します。Gets the location of the specified SqlParameter with the specified name.

InitializeLifetimeService()

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

(継承元 MarshalByRefObject)
Insert(Int32, Object)

ObjectSqlParameterCollection 内の指定されたインデックス位置に挿入します。Inserts an Object into the SqlParameterCollection at the specified index.

Insert(Int32, SqlParameter)

SqlParameter オブジェクトを SqlParameterCollection 内の指定されたインデックス位置に挿入します。Inserts a SqlParameter object into the SqlParameterCollection at the specified index.

MemberwiseClone()

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

(継承元 Object)
MemberwiseClone(Boolean)

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

(継承元 MarshalByRefObject)
Remove(Object)

指定された SqlParameter をコレクションから削除します。Removes the specified SqlParameter from the collection.

Remove(SqlParameter)

指定された SqlParameter をコレクションから削除します。Removes the specified SqlParameter from the collection.

RemoveAt(Int32)

指定されたインデックス位置にある SqlParameterSqlParameterCollection から削除します。Removes the SqlParameter from the SqlParameterCollection at the specified index.

RemoveAt(String)

指定されたパラメーター名を持つ SqlParameterSqlParameterCollection から削除します。Removes the SqlParameter from the SqlParameterCollection at the specified parameter name.

ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

拡張メソッド

Cast<TResult>(IEnumerable)

IEnumerable の要素を、指定した型にキャストします。Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

指定された型に基づいて IEnumerable の要素をフィルター処理します。Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

クエリの並列化を有効にします。Enables parallelization of a query.

AsQueryable(IEnumerable)

IEnumerableIQueryable に変換します。Converts an IEnumerable to an IQueryable.

適用対象

こちらもご覧ください