This documentation is archived and is not being maintained.

SqlParameterCollection.Item Property (String)

Gets the SqlParameter with the specified name.

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

public SqlParameter this [
	string parameterName
] { get; set; 
/** @property */
public SqlParameter get_Item (String parameterName)

/** @property */
public void set_Item (String parameterName, SqlParameter value)

JScript supports the use of indexed properties, but not the declaration of new ones.

Parameters

parameterName

The name of the parameter to retrieve.

Property Value

The SqlParameter with the specified name.

Exception typeCondition

IndexOutOfRangeException

The specified name does not exist.

The following example looks for a SqlParameter with a given ParameterName within a SqlParameterCollection. If the parameter exists, the example displays the index of the parameter. If the parameter does not exist, the example displays an error. This example assumes that a SqlParameterCollection has already been created by a SqlCommand.

public void SearchSqlParams(SqlCommand command)
{
    SqlParameter searchParameter = (SqlParameter)
        command.Parameters["Description"];

    if (searchParameter == null)
        Console.WriteLine("ERROR: no such parameter in the collection.");
    else
        Console.WriteLine("Match on parameter #{0",
            command.Parameters.IndexOf("Description").ToString());


Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Show: