SqlParameter.ParameterName 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 SqlParameter.

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

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

public override string ParameterName { get; set; }

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

member this.ParameterName : string with get, set

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

Public Overrides Property ParameterName As String

Public Property ParameterName As String

Property Value

String

The name of the SqlParameter. The default is an empty string.

Implements

ParameterName

Attributes: DataSysDescriptionAttribute

Examples

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

private static void AddSqlParameter(SqlCommand command)
{
    SqlParameter parameter = new SqlParameter();
    parameter.ParameterName = "@Description";
    parameter.IsNullable = true;
    parameter.DbType = DbType.String;
    parameter.Direction = ParameterDirection.Output;

    command.Parameters.Add(parameter);
}

Private Sub AddSqlParameter(ByVal command As SqlCommand)

    Dim parameter As New SqlParameter()
    With parameter
        .ParameterName = "@Description"
        .IsNullable = True
        .DbType = DbType.String
        .Direction = ParameterDirection.Output
    End With

    command.Parameters.Add(parameter)
End Sub

Remarks

The ParameterName is specified in the form @paramname. You must set ParameterName before executing a SqlCommand that relies on parameters.

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