IDataParameter.SourceVersion Property

Definition

Gets or sets the DataRowVersion to use when loading Value.

public:
 property System::Data::DataRowVersion SourceVersion { System::Data::DataRowVersion get(); void set(System::Data::DataRowVersion value); };
public System.Data.DataRowVersion SourceVersion { get; set; }
member this.SourceVersion : System.Data.DataRowVersion with get, set
Public Property SourceVersion As DataRowVersion

Property Value

One of the DataRowVersion values. The default is Current.

Exceptions

The property was not set one of the DataRowVersion values.

Examples

The following example creates an instance of the implementing class, SqlParameter, and sets some of its properties.

public void CreateSqlParameter()
{
    SqlParameter parameter = new SqlParameter(
        "@Description", SqlDbType.VarChar);
    parameter.IsNullable = true;
    parameter.SourceColumn = "Description";
    parameter.SourceVersion = DataRowVersion.Current;
    parameter.Direction = ParameterDirection.Output;
}
Public Sub CreateSqlParameter()
    Dim parameter As New SqlParameter( _
        "@Description", SqlDbType.VarChar)
    parameter.IsNullable = True
    parameter.SourceColumn = "Description"
    parameter.SourceVersion = DataRowVersion.Current
    parameter.Direction = ParameterDirection.Output
End Sub

Remarks

This property is used by the UpdateCommand during the Update to determine whether the original or current value is used for a parameter value. This allows primary keys to be updated. This property is ignored by the InsertCommand and DeleteCommand. This property is set to the version of the DataRow used by the Item[] property, or the GetChildRows method of the DataRow object.

Applies to