SqlParameterCollection.AddWithValue(String, Object) Método

  • Referencia

Definición

Espacio de nombres:
System.Data.SqlClient
Ensamblado:
System.Data.SqlClient.dll
Ensamblado:
System.Data.dll
Paquete:
System.Data.SqlClient v4.8.6

Agrega un valor al final del SqlParameterCollection.

public:
 System::Data::SqlClient::SqlParameter ^ AddWithValue(System::String ^ parameterName, System::Object ^ value);
public System.Data.SqlClient.SqlParameter AddWithValue (string parameterName, object value);
member this.AddWithValue : string * obj -> System.Data.SqlClient.SqlParameter
Public Function AddWithValue (parameterName As String, value As Object) As SqlParameter

Parámetros

parameterName
String

Nombre del parámetro.

value
Object

Valor que se va a agregar. Use Value en lugar de null para indicar un valor NULL.

Devoluciones

SqlParameter

Objeto SqlParameter.

Ejemplos

En el ejemplo siguiente se muestra cómo usar el método AddWithValue.

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

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

Comentarios

AddWithValue reemplaza el método SqlParameterCollection.Add que toma un String y un Object. La sobrecarga de Add que toma una cadena y un objeto estaba en desuso debido a la posible ambigüedad con la sobrecarga de SqlParameterCollection.Add que toma un String y un valor de enumeración SqlDbType donde pasar un entero con la cadena podría interpretarse como el valor del parámetro o el valor de SqlDbType correspondiente. Use AddWithValue siempre que quiera agregar un parámetro especificando su nombre y valor.

Para SqlDbTypeXml valores de enumeración, puede usar una cadena, un valor XML, una instancia de tipo derivado de XmlReader o un objeto SqlXml.

Se aplica a

Consulte también