SqlParameter.SourceColumn Property

Reference

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Package:: System.Data.SqlClient v4.9.0

Source:: System.Data.SqlClient.notsupported.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the name of the source column mapped to the DataSet and used for loading or returning the Value.

public:
 virtual property System::String ^ SourceColumn { System::String ^ get(); void set(System::String ^ value); };

public:
 property System::String ^ SourceColumn { System::String ^ get(); void set(System::String ^ value); };

public override string SourceColumn { get; set; }

[System.Data.DataSysDescription("DataParameter_SourceColumn")]
public string SourceColumn { get; set; }

member this.SourceColumn : string with get, set

[<System.Data.DataSysDescription("DataParameter_SourceColumn")>]
member this.SourceColumn : string with get, set

Public Overrides Property SourceColumn As String

Public Property SourceColumn As String

Property Value

String

The name of the source column mapped to the DataSet. The default is an empty string.

Implements

SourceColumn

Attributes: DataSysDescriptionAttribute

Examples

The following example creates a SqlParameter and sets some of its properties.

static void CreateSqlParameterSourceColumn()
{
    SqlParameter parameter = new SqlParameter("Description", SqlDbType.VarChar, 88);
    parameter.SourceColumn = "Description";
}

Private Sub CreateSqlParameterSourceColumn()
    Dim parameter As New SqlParameter("Description", SqlDbType.VarChar, 88)
    parameter.SourceColumn = "Description"
End Sub

Remarks

When SourceColumn is set to anything other than an empty string, the value of the parameter is retrieved from the column with the SourceColumn name. If Direction is set to Input, the value is taken from the DataSet. If Direction is set to Output, the value is taken from the data source. A Direction of InputOutput is a combination of both.

For more information about how to use the SourceColumn property, see DataAdapter Parameters and Updating Data Sources with DataAdapters.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, 6 (package-provided), 7 (package-provided), 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)

Share via