SqlParameterCollection.Item[] Propiedad

Definición

Espacio de nombres:

System.Data.SqlClient

Ensamblado:

System.Data.SqlClient.dll

Paquete:

System.Data.SqlClient v4.8.6

Obtiene el objeto SqlParameter con un atributo especificado.

Sobrecargas

Item[String]	Obtiene el objeto SqlParameter con el nombre especificado.
Item[Int32]	Obtiene el objeto SqlParameter en el índice especificado.

Item[String]

Obtiene el objeto SqlParameter con el nombre 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

Nombre del parámetro que se va a recuperar.

Valor de propiedad

SqlParameter

Objeto SqlParameter con el nombre especificado.

Excepciones

IndexOutOfRangeException

El valor especificado en parameterName no es válido.

Comentarios

parameterName se usa para buscar el valor de índice en el subyacenteSqlParameterCollection. Si no parameterName es válido, se producirá una IndexOutOfRangeException excepción .

Consulte también

• Comandos y parámetros (ADO.NET)
• Parámetros de DataAdapter (ADO.NET)
• Uso del proveedor de datos de .NET Framework para SQL Server
• Información general de ADO.NET

Item[Int32]

Obtiene el objeto SqlParameter en el í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

Índice de base cero del parámetro que se va a recuperar.

Valor de propiedad

SqlParameter

Objeto SqlParameter en el índice especificado.

Excepciones

IndexOutOfRangeException

El índice especificado no existe.

Ejemplos

En el ejemplo siguiente se muestra cómo crear SqlParameter objetos para proporcionar un parámetro de entrada a un procedimiento almacenado que devuelve resultados en un parámetro de salida. El código recorre en iteración los elementos de SqlParameterCollection y muestra algunas propiedades de parámetro en la ventana de la consola. En este ejemplo se supone un cadena de conexión válido para la base de datos de ejemplo AdventureWorks en una instancia 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;
        }
    }
}

Consulte también

• Comandos y parámetros (ADO.NET)
• Parámetros de DataAdapter (ADO.NET)
• Uso del proveedor de datos de .NET Framework para SQL Server
• Información general de ADO.NET