SqlParameterCollection.Item[] プロパティ

定義

名前空間:

System.Data.SqlClient

アセンブリ:

System.Data.SqlClient.dll

パッケージ:

System.Data.SqlClient v4.8.6

指定された属性を持つ SqlParameter を取得します。

オーバーロード

Item[String]	指定された名前を持つ SqlParameter を取得します。
Item[Int32]	指定されたインデックス位置にある SqlParameter を取得します。

Item[String]

指定された名前を持つ SqlParameter を取得します。

public:
 property System::Data::SqlClient::SqlParameter ^ default[System::String ^] { System::Data::SqlClient::SqlParameter ^ get(System::String ^ parameterName); void set(System::String ^ parameterName, System::Data::SqlClient::SqlParameter ^ value); };

public System.Data.SqlClient.SqlParameter this[string parameterName] { get; set; }

member this.Item(string) : System.Data.SqlClient.SqlParameter with get, set

Default Public Property Item(parameterName As String) As SqlParameter

パラメーター

parameterName

String

取得するパラメーターの名前。

プロパティ値

SqlParameter

指定された名前の SqlParameter。

例外

IndexOutOfRangeException

指定した parameterName が有効ではありません。

注釈

parameterNameは、基になる SqlParameterCollectionのインデックス値を検索するために使用されます。 parameterNameが有効でない場合は、 IndexOutOfRangeException がスローされます。

こちらもご覧ください

• コマンドとパラメーター (ADO.NET)
• DataAdapter パラメーター (ADO.NET)
• SQL Serverに.NET Framework データ プロバイダーを使用する
• ADO.NET の概要

Item[Int32]

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

public:
 property System::Data::SqlClient::SqlParameter ^ default[int] { System::Data::SqlClient::SqlParameter ^ get(int index); void set(int index, System::Data::SqlClient::SqlParameter ^ value); };

public System.Data.SqlClient.SqlParameter this[int index] { get; set; }

member this.Item(int) : System.Data.SqlClient.SqlParameter with get, set

Default Public Property Item(index As Integer) As SqlParameter

パラメーター

index

Int32

取得するパラメーターの 0 から始まるインデックス。

プロパティ値

SqlParameter

指定したインデックスにある SqlParameter です。

例外

IndexOutOfRangeException

指定されたインデックスは存在しません。

例

次の例では、出力パラメーターの結果を SqlParameter 返すストアド プロシージャに入力パラメーターを指定するオブジェクトを作成する方法を示します。 このコードでは、 内 SqlParameterCollection の項目を反復処理し、コンソール ウィンドウにいくつかのパラメーター プロパティを表示します。 この例では、SQL Server のインスタンス上の AdventureWorks サンプル データベースに対する有効な接続文字列を想定しています。

static private string CreateSqlParameters(int documentID)
{
    // Assumes GetConnectionString returns a valid connection string to the
    // AdventureWorks sample database on an instance of SQL Server 2005.
    using (SqlConnection connection =
               new SqlConnection(GetConnectionString()))
    {
        connection.Open();
        SqlCommand command = connection.CreateCommand();
        try
        {
            // Setup the command to execute the stored procedure.
            command.CommandText = "GetDocumentSummary";
            command.CommandType = CommandType.StoredProcedure;

            // Create the input parameter for the DocumentID.
            SqlParameter paramID =
                new SqlParameter("@DocumentID", SqlDbType.Int);
            paramID.Value = documentID;
            command.Parameters.Add(paramID);

            // Create the output parameter to retrieve the summary.
            SqlParameter paramSummary =
                new SqlParameter("@DocumentSummary", SqlDbType.NVarChar, -1);
            paramSummary.Direction = ParameterDirection.Output;
            command.Parameters.Add(paramSummary);

            // List the parameters and some of properties.
            SqlParameterCollection paramCollection = command.Parameters;
            string parameterList = "";
            for (int i = 0; i < paramCollection.Count; i++)
            {
                parameterList += String.Format("  {0}, {1}, {2}\n",
                    paramCollection[i], paramCollection[i].DbType,
                    paramCollection[i].Direction);
            }
            Console.WriteLine("Parameter Collection:\n" + parameterList);

            // Execute the stored procedure; retrieve
            // and display the output parameter value.
            command.ExecuteNonQuery();
            Console.WriteLine((String)(paramSummary.Value));
            return (String)(paramSummary.Value);
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
            return null;
        }
    }
}

こちらもご覧ください

• コマンドとパラメーター (ADO.NET)
• DataAdapter パラメーター (ADO.NET)
• SQL Serverに.NET Framework データ プロバイダーを使用する
• ADO.NET の概要