Note: This method is new in the .NET Framework version 2.0.
Adds a value to the end of the
SqlParameterCollection.
Namespace: System.Data.SqlClient
Assembly: System.Data (in system.data.dll)
Visual Basic (Declaration)
Public Function AddWithValue ( _
parameterName As String, _
value As Object _
) As SqlParameter
Dim instance As SqlParameterCollection
Dim parameterName As String
Dim value As Object
Dim returnValue As SqlParameter
returnValue = instance.AddWithValue(parameterName, value)
public SqlParameter AddWithValue (
string parameterName,
Object value
)
public:
SqlParameter^ AddWithValue (
String^ parameterName,
Object^ value
)
public SqlParameter AddWithValue (
String parameterName,
Object value
)
public function AddWithValue (
parameterName : String,
value : Object
) : SqlParameter
Parameters
- parameterName
The name of the parameter.
- value
The value to be added.
Return Value
A SqlParameter object.
The value can be a string, an XML value, a string, an XmlReader-derived type instance or a SqlXml object.
The following example demonstrates how to use the AddWithValue method.
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
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
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
.NET Framework
Supported in: 2.0
.NET Compact Framework
Supported in: 2.0