SqlParameterCollection.Item[] Propriedade

Definição

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Pacote:

System.Data.SqlClient v4.8.6

Obtém o SqlParameter com um atributo especificado.

Sobrecargas

Item[String]	Obtém o SqlParameter com o nome especificado.
Item[Int32]	Obtém o SqlParameter no índice especificado.

Item[String]

Obtém o SqlParameter com o nome especificado.

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

public System.Data.SqlClient.SqlParameter this[string parameterName] { get; set; }

member this.Item(string) : System.Data.SqlClient.SqlParameter with get, set

Default Public Property Item(parameterName As String) As SqlParameter

Parâmetros

parameterName

String

O nome do parâmetro a ser recuperado.

Valor da propriedade

SqlParameter

O SqlParameter com o nome especificado.

Exceções

IndexOutOfRangeException

O parameterName especificado não é válido.

Comentários

O parameterName é usado para pesquisar o valor do índice no subjacente SqlParameterCollection. Se o parameterName não for válido, um IndexOutOfRangeException será gerado.

Confira também

• Comandos e parâmetros (ADO.NET)
• Parâmetros DataAdapter (ADO.NET)
• Usando o provedor de dados .NET Framework para SQL Server
• Visão geral do ADO.NET

Item[Int32]

Obtém o SqlParameter no índice especificado.

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

public System.Data.SqlClient.SqlParameter this[int index] { get; set; }

member this.Item(int) : System.Data.SqlClient.SqlParameter with get, set

Default Public Property Item(index As Integer) As SqlParameter

Parâmetros

index

Int32

O índice baseado em zero do parâmetro a ser recuperado.

Valor da propriedade

SqlParameter

O SqlParameter no índice especificado.

Exceções

IndexOutOfRangeException

O índice especificado não existe.

Exemplos

O exemplo a seguir demonstra a criação SqlParameter de objetos para fornecer um parâmetro de entrada para um procedimento armazenado que retorna resultados em um parâmetro de saída. O código itera pelos itens no SqlParameterCollection e exibe algumas propriedades de parâmetro na janela do console. Este exemplo pressupõe uma cadeia de conexão válida para o banco de dados de exemplo AdventureWorks em uma instância de SQL Server.

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

Confira também

• Comandos e parâmetros (ADO.NET)
• Parâmetros DataAdapter (ADO.NET)
• Usando o provedor de dados .NET Framework para SQL Server
• Visão geral do ADO.NET