This documentation is archived and is not being maintained.

IDataParameter.ParameterName Property

Gets or sets the name of the IDataParameter.

Namespace: System.Data
Assembly: System.Data (in system.data.dll)

string ParameterName { get; set; }
/** @property */
String get_ParameterName ()

/** @property */
void set_ParameterName (String value)

function get ParameterName () : String

function set ParameterName (value : String)

Not applicable.

Property Value

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

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

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);
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: