SqlParameterCollection.AddWithValue(String, Object) メソッド

定義

名前空間:

Microsoft.Data.SqlClient

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v5.2.0

値を SqlParameterCollection の末尾に追加します。

public:
 Microsoft::Data::SqlClient::SqlParameter ^ AddWithValue(System::String ^ parameterName, System::Object ^ value);

public Microsoft.Data.SqlClient.SqlParameter AddWithValue (string parameterName, object value);

member this.AddWithValue : string * obj -> Microsoft.Data.SqlClient.SqlParameter

Public Function AddWithValue (parameterName As String, value As Object) As SqlParameter

パラメーター

parameterName

String

パラメーターの名前。

value

Object

追加する値。 null 値を示すために、null の代わりに、Value を使用します。

戻り値

SqlParameter

SqlParameter オブジェクト。

例

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

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


class Program
{
    static void Main()
    {
        string connectionString = GetConnectionString();
        string demo = @"<StoreSurvey xmlns=""http://schemas.microsoft.com/sqlserver/2004/07/adventure-works/StoreSurvey""><AnnualSales>1500000</AnnualSales><AnnualRevenue>150000</AnnualRevenue><BankName>Primary International</BankName><BusinessType>OS</BusinessType><YearOpened>1974</YearOpened><Specialty>Road</Specialty><SquareFeet>38000</SquareFeet><Brands>3</Brands><Internet>DSL</Internet><NumberEmployees>40</NumberEmployees></StoreSurvey>";
        Int32 id = 3;
        UpdateDemographics(id, demo, connectionString);
        Console.ReadLine();
    }
    private static void UpdateDemographics(Int32 customerID,
        string demoXml, string connectionString)
    {
        // Update the demographics for a store, which is stored 
        // in an xml column. 
        string commandText = "UPDATE Sales.Store SET Demographics = @demographics "
            + "WHERE CustomerID = @ID;";

        using (SqlConnection connection = new SqlConnection(connectionString))
        {
            SqlCommand command = new SqlCommand(commandText, connection);
            command.Parameters.Add("@ID", SqlDbType.Int);
            command.Parameters["@ID"].Value = customerID;

            // Use AddWithValue to assign Demographics.
            // SQL Server will implicitly convert strings into XML.
            command.Parameters.AddWithValue("@demographics", demoXml);

            try
            {
                connection.Open();
                Int32 rowsAffected = command.ExecuteNonQuery();
                Console.WriteLine("RowsAffected: {0}", rowsAffected);
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
        }
    }

注釈

AddWithValue は、 と を SqlParameterCollection.Add 受け取る String メソッドを Object置き換えます。 文字列と オブジェクトを受け取る のAddオーバーロードは、 を受け取るStringオーバーロードとSqlParameterCollection.AddSqlDbType列挙値とのあいまいさが考えられるため、非推奨となりました。ここで、文字列で整数を渡すと、パラメーター値または対応するSqlDbType値のいずれかとして解釈できます。 パラメーターの名前と値を指定して、パラメーターを追加する場合は常に を使用 AddWithValue します。

列挙値には SqlDbTypeXml 、文字列、XML 値、派生型インスタンス、 XmlReader または オブジェクトを SqlXml 使用できます。