SqlParameter Klasse

Definition

Stellt einen Parameter für einen SqlCommand und optional für seine Zuordnung zu DataSet-Spalten dar.Represents a parameter to a SqlCommand and optionally its mapping to DataSet columns. Diese Klasse kann nicht vererbt werden.This class cannot be inherited. Weitere Informationen zu Parametern finden Sie unter Konfigurieren von Parametern und Parameterdatentypen.For more information on parameters, see Configuring Parameters and Parameter Data Types.

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
[System.ComponentModel.TypeConverter("System.Data.SqlClient.SqlParameter+SqlParameterConverter, System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))]
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter/SqlParameterConverter))]
[System.ComponentModel.TypeConverter("System.Data.SqlClient.SqlParameter+SqlParameterConverter, System.Data, Version=2.0.5.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
Vererbung
SqlParameter
Attribute
Implementiert

Beispiele

Im folgenden Beispiel werden mehrere Instanzen von SqlParameter über die SqlParameterCollection Auflistung innerhalb des SqlDataAdaptererstellt.The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection within the SqlDataAdapter. Diese Parameter werden verwendet, um Daten aus der Datenquelle auszuwählen und die Daten in die DataSetzu platzieren.These parameters are used to select data from the data source and put the data in the DataSet. In diesem Beispiel wird davon ausgegangen, dass bereits eine DataSet und eine SqlDataAdapter mithilfe des entsprechenden Schemas, der Befehle und der Verbindung erstellt wurden.This example assumes that a DataSet and a SqlDataAdapter have already been created by using the appropriate schema, commands, and connection. Weitere Informationen und zusätzliche Beispiele zur Verwendung von Parametern finden Sie unter Abrufen und Ändern von Daten in ADO.net und Konfigurieren von Parametern und Parameter Datentypen.For more information and additional examples on using parameters, see Retrieving and Modifying Data in ADO.NET and Configuring Parameters and Parameter Data Types.

public void AddSqlParameters() 
{
// ...
// create categoriesDataSet and categoriesAdapter
// ...

  categoriesAdapter.SelectCommand.Parameters.Add(
    "@CategoryName", SqlDbType.VarChar, 80).Value = "toasters";
  categoriesAdapter.SelectCommand.Parameters.Add(
    "@SerialNum", SqlDbType.Int).Value = 239;
  categoriesAdapter.Fill(categoriesDataSet);
}
Public Sub AddSqlParameters()
    ' ...
    ' create categoriesDataSet and categoriesAdapter
    ' ...
    categoriesAdapter.SelectCommand.Parameters.Add( _
        "@CategoryName", SqlDbType.VarChar, 80).Value = "toasters"
    categoriesAdapter.SelectCommand.Parameters.Add( _
        "@SerialNum", SqlDbType.Int).Value = 239
    
    categoriesAdapter.Fill(categoriesDataSet)
End Sub  

Hinweise

Bei Parameternamen wird die Groß- und Kleinschreibung nicht berücksichtigt.Parameter names are not case sensitive.

Hinweis

Namenlos, auch als Ordinal bezeichnet, werden von der .NET Framework Datenanbieter für SQL Server nicht unterstützt.Nameless, also called ordinal, parameters are not supported by the .NET Framework Data Provider for SQL Server.

Weitere Informationen sowie zusätzlichen Beispielcode, der die Verwendung von Parametern veranschaulicht, finden Sie unter Befehle und Parameter.For more information, along with additional sample code demonstrating how to use parameters, see Commands and Parameters.

Konstruktoren

SqlParameter()

Initialisiert eine neue Instanz der SqlParameter-Klasse.Initializes a new instance of the SqlParameter class.

SqlParameter(String, Object)

Initialisiert eine neue Instanz der SqlParameter-Klasse, die den Parameternamen und einen Wert des neuen SqlParameter verwendet.Initializes a new instance of the SqlParameter class that uses the parameter name and a value of the new SqlParameter.

SqlParameter(String, SqlDbType)

Initialisiert eine neue Instanz der SqlParameter-Klasse, die den Parameternamen und den Datentyp verwendet.Initializes a new instance of the SqlParameter class that uses the parameter name and the data type.

SqlParameter(String, SqlDbType, Int32)

Initialisiert eine neue Instanz der SqlParameter-Klasse, die den Parameternamen, den SqlDbType und die Größe verwendet.Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, and the size.

SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)

Initialisiert eine neue Instanz der SqlParameter-Klasse, die den Parameternamen, den Typ des Parameters, die Größe des Parameters, ein ParameterDirection, die Genauigkeit des Parameters, die Skalierung des Parameters, die Quellspalte, ein zu verwendendes DataRowVersion und den Wert des Parameters verwendet.Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the size of the parameter, a ParameterDirection, the precision of the parameter, the scale of the parameter, the source column, a DataRowVersion to use, and the value of the parameter.

SqlParameter(String, SqlDbType, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object, String, String, String)

Initialisiert eine neue Instanz der SqlParameter-Klasse, die Folgendes verwendet: den Parameternamen, den Parametertyp, die Parameterlänge, die Richtung, die Genauigkeit, die Skala, den Namen der Quellspalte, einen der DataRowVersion-Werte, einen booleschen Wert für die Quellspaltenzuordnung, den Wert von SqlParameter, den Namen der Datenbank, in der sich die Schemaauflistung für diese XML-Instanz befindet, das besitzende relationale Schema, in dem sich die Schemaauflistung für diese XML-Instanz befindet, und den Namen der Schemaauflistung für diesen Parameter.Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the length of the parameter the direction, the precision, the scale, the name of the source column, one of the DataRowVersion values, a Boolean for source column mapping, the value of the SqlParameter, the name of the database where the schema collection for this XML instance is located, the owning relational schema where the schema collection for this XML instance is located, and the name of the schema collection for this parameter.

SqlParameter(String, SqlDbType, Int32, String)

Initialisiert eine neue Instanz der SqlParameter-Klasse, die den Parameternamen, den SqlDbType, die Größe und den Quellspaltennamen verwendet.Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, the size, and the source column name.

Eigenschaften

CompareInfo

Ruft das CompareInfo-Objekt ab, das definiert, wie für diesen Parameter Zeichenfolgenvergleiche durchgeführt werden sollen, oder legt dieses fest.Gets or sets the CompareInfo object that defines how string comparisons should be performed for this parameter.

DbType

Ruft den SqlDbType des Parameters ab oder legt ihn fest.Gets or sets the SqlDbType of the parameter.

Direction

Ruft einen Wert ab, der angibt, ob der Parameter ein reiner Eingabe- bzw. Ausgabeparameter, bidirektional oder ein Parameter für den Rückgabewert einer gespeicherten Prozedur ist, oder legt ihn fest.Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

ForceColumnEncryption

Erzwingt die Verschlüsselung eines Parameters bei Verwendung von Always Encrypted.Enforces encryption of a parameter when using Always Encrypted. Wenn SQL Server den Treiber darauf hinweist, dass der Parameter nicht verschlüsselt werden muss, misslingt die Abfrage bei Verwendung des Parameters.If SQL Server informs the driver that the parameter does not need to be encrypted, the query using the parameter will fail. Diese Eigenschaft bietet zusätzlichen Schutz vor Angriffen, bei denen ein gefährdeter SQL Server dem Client falsche Verschlüsselungsmetadaten bereitstellt, was zur Offenlegung von Daten führen kann.This property provides additional protection against security attacks that involve a compromised SQL Server providing incorrect encryption metadata to the client, which may lead to data disclosure.

IsNullable

Ruft einen Wert ab, der angibt, ob der Parameter NULL-Werte akzeptiert, oder legt diesen fest.Gets or sets a value that indicates whether the parameter accepts null values. IsNullable wird nicht verwendet, um den Parameterwert zu überprüfen, und verhindert nicht, dass beim Ausführen eines Befehls ein NULL-Wert gesendet oder empfangen wird.IsNullable is not used to validate the parameter's value and will not prevent sending or receiving a null value when executing a command.

LocaleId

Ruft den Gebietsschemabezeichner ab, der Konventionen und die Sprache für eine bestimmte Region bestimmt, oder legt diesen fest.Gets or sets the locale identifier that determines conventions and language for a particular region.

Offset

Ruft den Offset zur Value-Eigenschaft ab oder legt diesen fest.Gets or sets the offset to the Value property.

ParameterName

Ruft den Namen der SqlParameter ab oder legt diesen fest.Gets or sets the name of the SqlParameter.

Precision

Ruft die maximale Anzahl von Ziffern ab, die zur Darstellung der Value-Eigenschaft verwendet werden kann, oder legt diese fest.Gets or sets the maximum number of digits used to represent the Value property.

Scale

Ruft die Anzahl der Dezimalstellen ab, in die Value aufgelöst wird, oder legt diese fest.Gets or sets the number of decimal places to which Value is resolved.

Size

Ruft die maximale Größe der Daten in der Spalte in Byte ab oder legt diese fest.Gets or sets the maximum size, in bytes, of the data within the column.

SourceColumn

Ruft den Namen der Quellspalte ab, die dem DataSet zugeordnet ist und zum Laden oder Zurückgeben des Value verwendet wird, oder legt diesen Namen fest.Gets or sets the name of the source column mapped to the DataSet and used for loading or returning the Value

SourceColumnNullMapping

Ruft einen Wert ab oder legt einen Wert fest, der angibt, ob die Quellspalte NULL-Werte zulässt.Gets or sets a value which indicates whether the source column is nullable. Dadurch kann SqlCommandBuilder ordnungsgemäß Update-Anweisungen für Spalten generieren, die NULL-Werte zulassen.This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.

SourceVersion

Ruft die DataRowVersion ab, die beim Laden von Value verwendet werden soll, oder legt diese fest.Gets or sets the DataRowVersion to use when you load Value

SqlDbType

Ruft den SqlDbType des Parameters ab oder legt ihn fest.Gets or sets the SqlDbType of the parameter.

SqlValue

Dient zum Abrufen oder Festlegen des Werts des Parameters als SQL-Typ.Gets or sets the value of the parameter as an SQL type.

TypeName

Dient zum Abrufen oder Festlegen des Typnamens für einen Tabellenwertparameter.Gets or sets the type name for a table-valued parameter.

UdtTypeName

Ruft eine string ab, die einen benutzerdefinierten Typ als Parameter darstellt, oder legt diese fest.Gets or sets a string that represents a user-defined type as a parameter.

Value

Ruft den Wert des Parameters ab oder legt diesen fest.Gets or sets the value of the parameter.

XmlSchemaCollectionDatabase

Ruft den Namen der Datenbank ab, in der sich die Schemaauflistung für diese XML-Instanz befindet.Gets the name of the database where the schema collection for this XML instance is located.

XmlSchemaCollectionName

Ruft den Namen der Schemaauflistung für diese XML-Instanz ab.Gets the name of the schema collection for this XML instance.

XmlSchemaCollectionOwningSchema

Das besitzende relationale Schema, in dem sich die Schemaauflistung für diese XML-Instanz befindet.The owning relational schema where the schema collection for this XML instance is located.

Methoden

CreateObjRef(Type)

Erstellt ein Objekt mit allen relevanten Informationen, die zum Generieren eines Proxys für die Kommunikation mit einem Remoteobjekt erforderlich sind.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Geerbt von MarshalByRefObject)
Equals(Object)

Ermittelt, ob das angegebene Objekt und das aktuelle Objekt gleich sind.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Dient als die Standard-HashfunktionServes as the default hash function.

(Geerbt von Object)
GetLifetimeService()

Ruft das aktuelle Lebensdauerdienstobjekt ab, das die Lebensdauerrichtlinien für diese Instanz steuert.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Geerbt von MarshalByRefObject)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
InitializeLifetimeService()

Ruft ein Lebensdauerdienstobjekt zur Steuerung der Lebensdauerrichtlinie für diese Instanz ab.Obtains a lifetime service object to control the lifetime policy for this instance.

(Geerbt von MarshalByRefObject)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
MemberwiseClone(Boolean)

Erstellt eine flache Kopie des aktuellen MarshalByRefObject-Objekts.Creates a shallow copy of the current MarshalByRefObject object.

(Geerbt von MarshalByRefObject)
ResetDbType()

Setzt den diesem SqlParameter zugeordneten Typ zurück.Resets the type associated with this SqlParameter.

ResetSqlDbType()

Setzt den diesem SqlParameter zugeordneten Typ zurück.Resets the type associated with this SqlParameter.

ToString()

Ruft eine Zeichenfolge ab, die den ParameterName enthält.Gets a string that contains the ParameterName.

Explizite Schnittstellenimplementierungen

ICloneable.Clone()

Eine Beschreibung dieses Members finden Sie unter Clone().For a description of this member, see Clone().

IDataParameter.SourceVersion (Geerbt von DbParameter)
IDbDataParameter.Precision

Gibt die Genauigkeit numerischer Parameter an.Indicates the precision of numeric parameters.

(Geerbt von DbParameter)
IDbDataParameter.Scale

Eine Beschreibung dieses Members finden Sie unter Scale.For a description of this member, see Scale.

(Geerbt von DbParameter)

Gilt für:

Siehe auch