SqlParameterCollection.AddWithValue メソッド

.NET Framework クラス ライブラリ リファレンス

SqlParameterCollection.AddWithValue メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Data.SqlClient
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As SqlParameterCollection
Dim parameterName As String
Dim value As Object
Dim returnValue As SqlParameter

returnValue = instance.AddWithValue(parameterName, value)

C#

public SqlParameter AddWithValue (
    string parameterName,
    Object value
)

C++

public:
SqlParameter^ AddWithValue (
    String^ parameterName, 
    Object^ value
)

J#

public SqlParameter AddWithValue (
    String parameterName, 
    Object value
)

JScript

public function AddWithValue (
    parameterName : String, 
    value : Object
) : SqlParameter

パラメータ

parameterName

パラメータの名前。

value

追加される値。

戻り値
SqlParameter オブジェクト。

解説

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

使用例

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

Visual Basic

Private Sub UpdateDemographics(ByVal
 customerID As Integer, _
    ByVal demoXml As String,
 _
    ByVal connectionString As String)

    ' Update the demographics for a store, which is stored 
    ' in an xml column.
    Dim commandText As String
 = _
     "UPDATE Sales.Store SET Demographics = @demographics "
 _
     & "WHERE CustomerID = @ID;"

    Using connection As New SqlConnection(connectionString)
        Dim command As New
 SqlCommand(commandText, connection)

        ' Add CustomerID parameter for WHERE clause.
        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()
            Dim rowsAffected As Integer
 = command.ExecuteNonQuery()
            Console.WriteLine("RowsAffected: {0}",
 rowsAffected)

        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try
    End Using
End Sub

C#

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);
        }
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
SqlParameterCollection クラス
SqlParameterCollection メンバ
System.Data.SqlClient 名前空間
その他の技術情報
ADO.NET でのデータへの接続およびデータの取得
.NET Framework Data Provider for SQL Server の使用