SqlParameter.ParameterName Property

Definition

Gets or sets the name of the SqlParameter.

C#
public override string ParameterName { get; set; }

Property Value

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

Implements

Examples

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

C#
using Microsoft.Data.SqlClient;

class Program
{
    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);
    }
}

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
SqlClient .NET Core 1.0, 1.1, 2.0, 2.1, 3.0, 3.1, 4.0, 4.1, 5.0, 5.1, 5.2
SqlClient .NET Framework 1.0, 1.1, 2.0, 2.1, 3.0, 3.1, 4.0, 4.1, 5.0, 5.1, 5.2
SqlClient .NET Standard 1.0, 1.1, 2.0, 2.1, 3.0, 3.1, 4.0, 4.1, 5.0, 5.1, 5.2