SqlParameterCollection.Item[] Property

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

Overloads

Item[String]	Gets the SqlParameter with the specified name.
Item[Int32]	Gets the SqlParameter at the specified index.

Item[String]

Gets the SqlParameter with the specified name.

public:
 property Microsoft::Data::SqlClient::SqlParameter ^ default[System::String ^] { Microsoft::Data::SqlClient::SqlParameter ^ get(System::String ^ parameterName); void set(System::String ^ parameterName, Microsoft::Data::SqlClient::SqlParameter ^ value); };

[System.ComponentModel.Browsable(false)]
public Microsoft.Data.SqlClient.SqlParameter this[string parameterName] { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.Item(string) : Microsoft.Data.SqlClient.SqlParameter with get, set

Default Public Property Item(parameterName As String) As SqlParameter

Parameters

parameterName

String

The name of the parameter to retrieve.

Property Value

SqlParameter

The SqlParameter with the specified name.

Attributes

BrowsableAttribute

Exceptions

IndexOutOfRangeException

The specified parameterName is not valid.

Remarks

The parameterName is used to look up the index value in the underlying SqlParameterCollection. If the parameterName is not valid, an IndexOutOfRangeException will be thrown.

Item[Int32]

Gets the SqlParameter at the specified index.

public:
 property Microsoft::Data::SqlClient::SqlParameter ^ default[int] { Microsoft::Data::SqlClient::SqlParameter ^ get(int index); void set(int index, Microsoft::Data::SqlClient::SqlParameter ^ value); };

[System.ComponentModel.Browsable(false)]
public Microsoft.Data.SqlClient.SqlParameter this[int index] { get; set; }

[<System.ComponentModel.Browsable(false)>]
member this.Item(int) : Microsoft.Data.SqlClient.SqlParameter with get, set

Default Public Property Item(index As Integer) As SqlParameter

Parameters

index

Int32

The zero-based index of the parameter to retrieve.

Property Value

SqlParameter

The SqlParameter at the specified index.

Attributes

BrowsableAttribute

Exceptions

IndexOutOfRangeException

The specified index does not exist.

Examples

The following example demonstrates creating SqlParameter objects to supply an input parameter to a stored procedure that returns results in an output parameter. The code iterates through the items in the SqlParameterCollection and displays some parameter properties in the console window. This example assumes a valid connection string to the AdventureWorks sample database on an instance of SQL Server.

using Microsoft.Data.SqlClient;

class Program
{
    static void Main()
    {
        // Supply any valid Document ID value.
        // The value 7 is supplied for demonstration purposes.
        string summaryString = CreateSqlParameters(7);
        Console.ReadLine();
    }
    static private string CreateSqlParameters(int documentID)
    {
        // Assumes GetConnectionString returns a valid connection string to the
        // AdventureWorks sample database on an instance of SQL Server 2005.
        using (SqlConnection connection =
                   new SqlConnection(GetConnectionString()))
        {
            connection.Open();
            SqlCommand command = connection.CreateCommand();
            try
            {
                // Setup the command to execute the stored procedure.
                command.CommandText = "GetDocumentSummary";
                command.CommandType = CommandType.StoredProcedure;

                // Create the input parameter for the DocumentID.
                SqlParameter paramID =
                    new SqlParameter("@DocumentID", SqlDbType.Int);
                paramID.Value = documentID;
                command.Parameters.Add(paramID);

                // Create the output parameter to retrieve the summary.
                SqlParameter paramSummary =
                    new SqlParameter("@DocumentSummary", SqlDbType.NVarChar, -1);
                paramSummary.Direction = ParameterDirection.Output;
                command.Parameters.Add(paramSummary);

                // List the parameters and some of properties.
                SqlParameterCollection paramCollection = command.Parameters;
                string parameterList = "";
                for (int i = 0; i < paramCollection.Count; i++)
                {
                    parameterList += String.Format("  {0}, {1}, {2}\n",
                        paramCollection[i], paramCollection[i].DbType,
                        paramCollection[i].Direction);
                }
                Console.WriteLine("Parameter Collection:\n" + parameterList);

                // Execute the stored procedure; retrieve
                // and display the output parameter value.
                command.ExecuteNonQuery();
                Console.WriteLine((String)(paramSummary.Value));
                return (String)(paramSummary.Value);
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
                return null;
            }
        }
    }
    static private string GetConnectionString()
    {
        // To avoid storing the connection string in your code, 
        // you can retrieve it from a configuration file, using the 
        // System.Configuration.ConfigurationSettings.AppSettings property
        return "Data Source=(local);Initial Catalog=AdventureWorks;" +
            "Integrated Security=SSPI";
    }
}