SqlCommand.Prepare メソッド

public:
 override void Prepare();

public override void Prepare();

override this.Prepare : unit -> unit

Public Overrides Sub Prepare ()

例

Prepare メソッドの使用例を次に示します。

using System;
using System.Data;
using Microsoft.Data.SqlClient;

namespace SqlCommand_Prepare
{
    class Program
    {
        static void Main()
        {
            string connectionString = "Persist Security Info=False;Integrated Security=SSPI;database=Northwind;server=(local)";
            SqlCommandPrepareEx(connectionString);
            Console.ReadLine();

        }
        private static void SqlCommandPrepareEx(string connectionString)
        {
            using (SqlConnection connection = new SqlConnection(connectionString))
            {
                connection.Open();
                SqlCommand command = new SqlCommand(null, connection);

                // Create and prepare an SQL statement.
                command.CommandText =
                    "INSERT INTO Region (RegionID, RegionDescription) " +
                    "VALUES (@id, @desc)";
                SqlParameter idParam = new SqlParameter("@id", SqlDbType.Int, 0);
                SqlParameter descParam =
                    new SqlParameter("@desc", SqlDbType.Text, 100);
                idParam.Value = 20;
                descParam.Value = "First Region";
                command.Parameters.Add(idParam);
                command.Parameters.Add(descParam);

                // Call Prepare after setting the Commandtext and Parameters.
                command.Prepare();
                command.ExecuteNonQuery();

                // Change parameter values and call ExecuteNonQuery.
                command.Parameters[0].Value = 21;
                command.Parameters[1].Value = "Second Region";
                command.ExecuteNonQuery();
            }
        }

注釈

CommandTypeがStoredProcedureに設定されている場合、Prepareの呼び出しは成功するはずですが、no-opが発生する可能性があります。

Prepareを呼び出す前に、準備するステートメントの各パラメーターのデータ型を指定します。 可変長データ型を持つパラメーターごとに、 Size プロパティを必要な最大サイズに設定する必要があります。 Prepare は、これらの条件が満たされていない場合にエラーを返します。

Executeを呼び出した後にPrepare メソッドを呼び出すと、Size プロパティで指定された値より大きいパラメーター値は、パラメーターの元の指定したサイズに自動的に切り捨てられ、切り捨てエラーは返されません。

出力パラメーター (準備済みかどうかに関係なく) には、ユーザー指定のデータ型が必要です。 ベクターを除く可変長データ型を指定する場合は、最大 Sizeも指定する必要があります。

ベクター データ型の場合、 Size プロパティは無視されます。 ベクターのサイズは、SqlVector<T>型のValueから推論されます。

Visual Studio 2010 より前 Prepare 例外がスローされました。 Visual Studio 2010 以降、このメソッドは例外をスローしません。