SqlParameter Класс

Определение

Пространство имен:

Microsoft.Data.SqlClient

Сборка:

Microsoft.Data.SqlClient.dll

Пакет:

Microsoft.Data.SqlClient v5.2.0

Представляет параметр для объекта SqlCommand и (необязательно) его сопоставление со столбцами DataSet. Этот класс не наследуется. Дополнительные сведения о параметрах см. в разделе Настройка параметров.

public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable

public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable

type SqlParameter = class
    inherit DbParameter
    interface IDataParameter
    interface IDbDataParameter
    interface ICloneable

Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable

Наследование

DbParameter

SqlParameter

Реализации

IDataParameter IDbDataParameter ICloneable

Примеры

В следующем примере создается несколько экземпляров SqlParameter через коллекцию SqlParameterCollection в SqlDataAdapter. Эти параметры используются для выбора данных из источника данных и их вставки в DataSet. В этом примере предполагается DataSet , что и SqlDataAdapter уже созданы с помощью соответствующей схемы, команд и соединения. Дополнительные сведения и дополнительные примеры использования параметров см. в разделах Извлечение и изменение данных в ADO.NET и Настройка параметров.

using Microsoft.Data.SqlClient;
using System.Xml;
using System.Data.Common;
using System.Windows.Forms;

public class Form1 : Form
{
    protected DataSet categoriesDataSet;
    protected DataGrid dataGrid1;
    protected SqlDataAdapter categoriesAdapter;


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

    }
}

Комментарии

В именах параметров регистр символов не учитывается.

Примечание

Безымяные параметры, также называемые порядком, не поддерживаются поставщиком данных платформа .NET Framework для SQL Server.

Дополнительные сведения, а также дополнительные примеры кода, демонстрирующие использование параметров, см. в разделе Команды и параметры.

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

SqlParameter()	Инициализирует новый экземпляр класса SqlParameter.
SqlParameter(String, Object)	Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра и значение нового объекта SqlParameter.
SqlParameter(String, SqlDbType)	Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра и тип данных.
SqlParameter(String, SqlDbType, Int32)	Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра, SqlDbType и размер.
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)	Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра, тип, размер, направление ParameterDirection, точность, масштаб, исходный столбец, версию DataRowVersion и значение параметра.
SqlParameter(String, SqlDbType, Int32, ParameterDirection, Byte, Byte, String, DataRowVersion, Boolean, Object, String, String, String)	Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра, тип параметра, длину параметра, направление, точность, масштаб, имя исходного столбца, одно из значений DataRowVersion, логическое значение для сопоставления исходных столбцов, значение для SqlParameter, имя базы данных, в которой находится коллекция схем для данного экземпляра XML, реляционную схему-владельца, в которой находится коллекция схем для данного экземпляра XML, и имя коллекции схем для этого параметра.
SqlParameter(String, SqlDbType, Int32, String)	Инициализирует новый экземпляр класса SqlParameter, использующий имя параметра, SqlDbType, размер и имя исходного столбца.

Свойства

CompareInfo	Получает или задает объект CompareInfo, который определяет порядок сравнения строк для этого параметра.
DbType	Возвращает или устанавливает тип SqlDbType параметра.
Direction	Возвращает или задает значение, указывающее, является ли параметр только входным, только выходным, двунаправленным или параметром, возвращаемым хранимой процедурой.
ForceColumnEncryption	Обеспечивает шифрование параметра при использовании функции Always Encrypted. Если SQL Server сообщает драйверу, что параметр не должен быть зашифрован, запрос, использующий параметр, завершится ошибкой. Это свойство обеспечивает дополнительную защиту от атак на систему безопасности, включающих предоставление клиенту скомпрометированным SQL Server неверных метаданных шифрования, что может привести к раскрытию данных.
IsNullable	Возвращает или задает значение, указывающее, принимает ли этот параметр значения NULL. IsNullable не используется для проверки значения параметра и не препятствует отправке или получению значения NULL при выполнении команды.
LocaleId	Получает или задает идентификатор языкового стандарта, определяющий соглашения и язык для конкретного региона.
Offset	Получает или задает смещение для свойства Value.
ParameterName	Возвращает или задает имя таблицы для объекта SqlParameter.
Precision	Возвращает или задает максимальное количество цифр, используемых для представления свойства Value.
Scale	Возвращает или задает число десятичных разрядов, до которых вычисляется значение Value.
Size	Возвращает или задает максимальный размер (в байтах) данных внутри столбца.
SourceColumn	Получает или задает имя исходного столбца, сопоставленного DataSet и используемого для загрузки или возвращения значения Value.
SourceColumnNullMapping	Возвращает или задает значение, показывающее, допускает ли исходный столбец значение NULL. Это позволяет SqlCommandBuilder правильно создавать инструкции Update для столбцов со значением NULL.
SourceVersion	Возвращает или задает значение DataRowVersion при загрузке Value.
SqlDbType	Возвращает или устанавливает тип SqlDbType параметра.
SqlValue	Возвращает или задает значение параметра как тип SQL.
TypeName	Возвращает или задает имя типа для возвращающего табличное значение параметра.
UdtTypeName	Возвращает или задает объект string, представляющий определяемый пользователем тип в качестве параметра.
Value	Возвращает или задает значение параметра.
XmlSchemaCollectionDatabase	Возвращает имя базы данных, в которой находится коллекция схем для данного экземпляра XML.
XmlSchemaCollectionName	Возвращает имя коллекции схем для данного экземпляра XML.
XmlSchemaCollectionOwningSchema	Реляционная схема-владелец, в которой находится коллекция схем для данного экземпляра XML.

Методы

ResetDbType()	Сбрасывает тип, связанный с параметром SqlParameter.
ResetSqlDbType()	Сбрасывает тип, связанный с параметром SqlParameter.
ToString()	Возвращает строку, содержащую имя ParameterName.

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

ICloneable.Clone()

Описание этого члена см. в разделе Clone().

См. также раздел

• SqlParameterCollection
• SqlCommand