IDataParameter.ParameterName Property

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Gets or sets the name of the IDataParameter.

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

public string ParameterName { get; set; }

member this.ParameterName : string with get, set

Public Property ParameterName As String

Property Value

String

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

Examples

The following example creates an instance of the implementing class, 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 command that relies on parameters.