SqlParameterCollection.Item[] Eigenschaft

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Paket:

Microsoft.Data.SqlClient v5.2.0

Überlädt

Item[String]	Ruft den SqlParameter mit dem angegebenen Namen ab.
Item[Int32]	Ruft den SqlParameter am angegebenen Index ab.

Item[String]

Ruft den SqlParameter mit dem angegebenen Namen ab.

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

Parameter

parameterName

String

Der Name des abzurufenden Parameters.

Eigenschaftswert

SqlParameter

Der SqlParameter mit dem angegebenen Namen.

Attribute

BrowsableAttribute

Ausnahmen

IndexOutOfRangeException

Der angegebene parameterName ist ungültig.

Hinweise

Wird parameterName verwendet, um den Indexwert im zugrunde liegenden SqlParameterCollectionzu suchen. Wenn ungültig parameterName ist, wird eine IndexOutOfRangeException ausgelöst.

Item[Int32]

Ruft den SqlParameter am angegebenen Index ab.

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

Parameter

index

Int32

Der nullbasierte Index des abzurufenden Parameters.

Eigenschaftswert

SqlParameter

Das SqlParameter-Objekt am angegebenen Index.

Attribute

BrowsableAttribute

Ausnahmen

IndexOutOfRangeException

Der angegebene Index ist nicht vorhanden.

Beispiele

Das folgende Beispiel veranschaulicht das Erstellen von SqlParameter -Objekten zum Bereitstellen eines Eingabeparameters für eine gespeicherte Prozedur, die Ergebnisse in einem Ausgabeparameter zurückgibt. Der Code durchläuft die Elemente im SqlParameterCollection und zeigt einige Parametereigenschaften im Konsolenfenster an. In diesem Beispiel wird davon ausgegangen, dass eine gültige Verbindungszeichenfolge für die AdventureWorks-Beispieldatenbank auf einer Instanz von 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";
    }
}