SqlParameter SqlParameter SqlParameter SqlParameter Class

Определение

Представляет параметр для объекта SqlCommand и (необязательно) его сопоставление со столбцами DataSet.Represents a parameter to a SqlCommand and optionally its mapping to DataSet columns. Этот класс не наследуется.This class cannot be inherited. Дополнительные сведения о параметрах см. в разделе Настройка параметров и типов данных параметров.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
Наследование
Атрибуты
Реализации

Примеры

В следующем примере создается несколько экземпляров SqlParameter SqlParameterCollection через коллекцию SqlDataAdapterв.The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection within the SqlDataAdapter. Эти параметры используются для выбора данных из источника данных и помещения их в DataSet.These parameters are used to select data from the data source and put the data in the DataSet. В этом примере предполагается DataSet , что SqlDataAdapter объект и уже были созданы с помощью соответствующей схемы, команд и соединения.This example assumes that a DataSet and a SqlDataAdapter have already been created by using the appropriate schema, commands, and connection. Дополнительные сведения и дополнительные примеры использования параметров см. в разделе Получение и изменение данных в ADO.NET и Настройка параметров и типов данных параметров.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  

Комментарии

В именах параметров регистр символов не учитывается.Parameter names are not case sensitive.

Примечание

Без имени, также называемого порядковым номером, параметры не поддерживаются поставщиком данных .NET Framework для SQL Server.Nameless, also called ordinal, parameters are not supported by the .NET Framework Data Provider for SQL Server.

Дополнительные сведения и дополнительный пример кода, демонстрирующий использование параметров, см. в разделе команды и параметры.For more information, along with additional sample code demonstrating how to use parameters, see Commands and Parameters.

Конструкторы

SqlParameter() SqlParameter() SqlParameter() SqlParameter()

Инициализирует новый экземпляр класса SqlParameter.Initializes a new instance of the SqlParameter class.

SqlParameter(String, Object) SqlParameter(String, Object) SqlParameter(String, Object) SqlParameter(String, Object)

Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра и значение нового объекта SqlParameter.Initializes a new instance of the SqlParameter class that uses the parameter name and a value of the new SqlParameter.

SqlParameter(String, SqlDbType) SqlParameter(String, SqlDbType) SqlParameter(String, SqlDbType) SqlParameter(String, SqlDbType)

Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра и тип данных.Initializes a new instance of the SqlParameter class that uses the parameter name and the data type.

SqlParameter(String, SqlDbType, Int32) SqlParameter(String, SqlDbType, Int32) SqlParameter(String, SqlDbType, Int32) SqlParameter(String, SqlDbType, Int32)

Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра, SqlDbType и размер.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) SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object) SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object) SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)

Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра, тип, размер, направление ParameterDirection, точность, масштаб, исходный столбец, версию DataRowVersion и значение параметра.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, String) SqlParameter(String, SqlDbType, Int32, String) SqlParameter(String, SqlDbType, Int32, String) SqlParameter(String, SqlDbType, Int32, String)

Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра, SqlDbType, размер и имя исходного столбца.Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, the size, and the source column name.

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

Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра, тип параметра, длину параметра, направление, точность, масштаб, имя исходного столбца, одно из значений DataRowVersion, логическое значение для сопоставления исходных столбцов, значение для SqlParameter, имя базы данных, в которой находится коллекция схем для данного экземпляра XML, реляционную схему-владельца, в которой находится коллекция схем для данного экземпляра XML, и имя коллекции схем для этого параметра.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.

Свойства

CompareInfo CompareInfo CompareInfo CompareInfo

Получает или задает объект CompareInfo, который определяет порядок сравнения строк для этого параметра.Gets or sets the CompareInfo object that defines how string comparisons should be performed for this parameter.

DbType DbType DbType DbType

Возвращает или устанавливает тип SqlDbType параметра.Gets or sets the SqlDbType of the parameter.

Direction Direction Direction Direction

Возвращает или задает значение, указывающее, является ли параметр только входным, только выходным, двунаправленным или параметром, возвращаемым хранимой процедурой.Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

ForceColumnEncryption ForceColumnEncryption ForceColumnEncryption ForceColumnEncryption

Обеспечивает шифрование параметра при использовании функции Always Encrypted.Enforces encryption of a parameter when using Always Encrypted. Если SQL Server сообщает драйверу, что параметр шифровать не нужно, запрос, использующий этот параметр, завершится ошибкой.If SQL Server informs the driver that the parameter does not need to be encrypted, the query using the parameter will fail. Это свойство обеспечивает дополнительную защиту от атак на систему безопасности, которые подразумевают предоставление скомпрометированным сервером SQL Server неверных метаданных шифрования клиенту, что может привести к раскрытию данных.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 IsNullable IsNullable IsNullable

Возвращает или задает значение, указывающее, принимает ли этот параметр значения NULL.Gets or sets a value that indicates whether the parameter accepts null values. IsNullable не используется для проверки значения параметра и не препятствует отправке или получению значения NULL при выполнении команды.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 LocaleId LocaleId LocaleId

Получает или задает идентификатор языкового стандарта, определяющий соглашения и язык для конкретного региона.Gets or sets the locale identifier that determines conventions and language for a particular region.

Offset Offset Offset Offset

Получает или задает смещение для свойства Value.Gets or sets the offset to the Value property.

ParameterName ParameterName ParameterName ParameterName

Возвращает или задает имя таблицы для объекта SqlParameter.Gets or sets the name of the SqlParameter.

Precision Precision Precision Precision

Возвращает или задает максимальное число разрядов, используемых для представления свойства Value.Gets or sets the maximum number of digits used to represent the Value property.

Scale Scale Scale Scale

Возвращает или задает число десятичных разрядов, до которых вычисляется значение Value.Gets or sets the number of decimal places to which Value is resolved.

Size Size Size Size

Возвращает или задает максимальную длину данных (в байтах) в столбце.Gets or sets the maximum size, in bytes, of the data within the column.

SourceColumn SourceColumn SourceColumn SourceColumn

Получает или задает имя исходного столбца, сопоставленного DataSet и используемого для загрузки или возвращения значения Value.Gets or sets the name of the source column mapped to the DataSet and used for loading or returning the Value

SourceColumnNullMapping SourceColumnNullMapping SourceColumnNullMapping SourceColumnNullMapping

Возвращает или задает значение, показывающее, допускает ли исходный столбец значение NULL.Sets or gets a value which indicates whether the source column is nullable. Это позволяет SqlCommandBuilder правильно создавать инструкции Update для столбцов со значением NULL.This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.

SourceVersion SourceVersion SourceVersion SourceVersion

Возвращает или задает значение DataRowVersion при загрузке Value.Gets or sets the DataRowVersion to use when you load Value

SqlDbType SqlDbType SqlDbType SqlDbType

Возвращает или устанавливает тип SqlDbType параметра.Gets or sets the SqlDbType of the parameter.

SqlValue SqlValue SqlValue SqlValue

Возвращает или задает значение параметра как тип SQL.Gets or sets the value of the parameter as an SQL type.

TypeName TypeName TypeName TypeName

Возвращает или задает имя типа для возвращающего табличное значение параметра.Gets or sets the type name for a table-valued parameter.

UdtTypeName UdtTypeName UdtTypeName UdtTypeName

Возвращает или задает объект string, представляющий определяемый пользователем тип в качестве параметра.Gets or sets a string that represents a user-defined type as a parameter.

Value Value Value Value

Возвращает или задает значение параметра.Gets or sets the value of the parameter.

XmlSchemaCollectionDatabase XmlSchemaCollectionDatabase XmlSchemaCollectionDatabase XmlSchemaCollectionDatabase

Возвращает имя базы данных, в которой находится коллекция схем для данного экземпляра XML.Gets the name of the database where the schema collection for this XML instance is located.

XmlSchemaCollectionName XmlSchemaCollectionName XmlSchemaCollectionName XmlSchemaCollectionName

Возвращает имя коллекции схем для данного экземпляра XML.Gets the name of the schema collection for this XML instance.

XmlSchemaCollectionOwningSchema XmlSchemaCollectionOwningSchema XmlSchemaCollectionOwningSchema XmlSchemaCollectionOwningSchema

Реляционная схема-владелец, в которой находится коллекция схем для данного экземпляра XML.The owning relational schema where the schema collection for this XML instance is located.

Методы

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
ResetDbType() ResetDbType() ResetDbType() ResetDbType()

Сбрасывает тип, связанный с параметром SqlParameter.Resets the type associated with this SqlParameter.

ResetSqlDbType() ResetSqlDbType() ResetSqlDbType() ResetSqlDbType()

Сбрасывает тип, связанный с параметром SqlParameter.Resets the type associated with this SqlParameter.

ToString() ToString() ToString() ToString()

Возвращает строку, содержащую имя ParameterName.Gets a string that contains the ParameterName.

Явные реализации интерфейса

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()

Описание этого члена см. в разделе Clone().For a description of this member, see Clone().

Применяется к

Дополнительно