Язык

SqlParameter Класс

Определение

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

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

public ref class SqlParameter sealed : System::Data::Common::DbParameter
public ref class SqlParameter sealed : MarshalByRefObject, ICloneable, System::Data::IDbDataParameter
public ref class SqlParameter sealed : System::Data::Common::DbParameter, ICloneable
public sealed class SqlParameter : System.Data.Common.DbParameter
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))]
public sealed class SqlParameter : MarshalByRefObject, ICloneable, System.Data.IDbDataParameter
[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))]
public sealed class SqlParameter : System.Data.Common.DbParameter, ICloneable
type SqlParameter = class
    inherit DbParameter
[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameterConverter))>]
type SqlParameter = class
    inherit MarshalByRefObject
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlParameter+SqlParameterConverter))>]
type SqlParameter = class
    inherit DbParameter
    interface IDbDataParameter
    interface IDataParameter
    interface ICloneable
Public NotInheritable Class SqlParameter
Inherits DbParameter
Public NotInheritable Class SqlParameter
Inherits MarshalByRefObject
Implements ICloneable, IDbDataParameter
Public NotInheritable Class SqlParameter
Inherits DbParameter
Implements ICloneable
Наследование
SqlParameter
Наследование
Наследование
SqlParameter
Атрибуты
Реализации

Примеры

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

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

Комментарии

Имена параметров не учитывает регистр.

Note

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

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

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

Имя. Описание
SqlParameter()

Инициализирует новый экземпляр класса SqlParameter.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SqlParameter(String, Object)

Инициализирует новый экземпляр SqlParameter класса, использующего имя параметра и значение нового SqlParameter.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

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

Инициализирует новый экземпляр SqlParameter класса, использующего имя параметра, тип параметра, размер параметра, точность параметра, ParameterDirectionмасштаб параметра, масштаб параметра, исходный столбец, DataRowVersion используемый и значение параметра.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

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

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

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SqlParameter(String, SqlDbType, Int32, String)

Инициализирует новый экземпляр SqlParameter класса, использующего имя параметра, SqlDbTypeразмер и имя исходного столбца.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SqlParameter(String, SqlDbType, Int32)

Инициализирует новый экземпляр SqlParameter класса, использующего имя параметра, SqlDbTypeразмер и размер.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SqlParameter(String, SqlDbType)

Инициализирует новый экземпляр SqlParameter класса, использующего имя параметра и тип данных.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

Свойства

Имя. Описание
CompareInfo

Возвращает или задает объект, определяющий CompareInfo , как следует выполнять сравнение строк для этого параметра.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

DbType

Возвращает или задает SqlDbType параметр.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

Direction

Возвращает или задает значение, указывающее, является ли параметр возвращаемым значением только входных данных, только выходом, двунаправленным или возвращаемым параметром хранимой процедуры.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

ForceColumnEncryption

Принудительное шифрование параметра при использовании Always Encrypted. Если SQL Server сообщает драйверу, что параметру не нужно шифроваться, запрос с помощью параметра завершится ошибкой. Это свойство обеспечивает дополнительную защиту от атак безопасности, включающих скомпрометированный SQL Server предоставления неверных метаданных шифрования клиенту, что может привести к раскрытию данных.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

IsNullable

Возвращает или задает значение, указывающее, принимает ли параметр значения NULL. IsNullable не используется для проверки значения параметра и не предотвращает отправку или получение значения NULL при выполнении команды.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

LocaleId

Возвращает или задает идентификатор языкового стандарта, определяющий соглашения и язык для определенного региона.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

Offset

Возвращает или задает смещение Value для свойства.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

ParameterName

Возвращает или задает имя SqlParameterобъекта .

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

Precision

Возвращает или задает максимальное количество цифр, используемых для представления Value свойства.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

Scale

Возвращает или задает число десятичных разрядов, для которых Value разрешено.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

Size

Возвращает или задает максимальный размер данных в байтах столбца.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SourceColumn

Возвращает или задает имя исходного столбца, сопоставленного с DataSet и используемым для загрузки или возврата Value.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SourceColumnNullMapping

Возвращает или задает значение, указывающее, является ли исходный столбец пустым. Это позволяет SqlCommandBuilder правильно создавать инструкции Update для столбцов, допускающих значение NULL.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SourceVersion

Возвращает или задает значение, используемое при загрузке DataRowVersionValue.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SqlDbType

Возвращает или задает SqlDbType параметр.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

SqlValue

Возвращает или задает значение параметра в качестве типа SQL.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

TypeName

Возвращает или задает имя типа для табличного параметра.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

UdtTypeName

Возвращает или задает объект string , представляющий определяемый пользователем тип в качестве параметра.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

Value

Возвращает или задает значение параметра.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

XmlSchemaCollectionDatabase

Возвращает имя базы данных, в которой находится коллекция схем для этого экземпляра XML.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

XmlSchemaCollectionName

Возвращает имя коллекции схем для этого экземпляра XML.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

XmlSchemaCollectionOwningSchema

Собственная реляционная схема, в которой находится коллекция схем для этого экземпляра XML.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

Методы

Имя. Описание
CreateObjRef(Type)

Создает объект, содержащий все соответствующие сведения, необходимые для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.

(Унаследовано от MarshalByRefObject)
Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetLifetimeService()
Устаревшие.

Извлекает текущий объект службы времени существования, который управляет политикой времени существования для этого экземпляра.

(Унаследовано от MarshalByRefObject)
GetType()

Возвращает Type текущего экземпляра.

(Унаследовано от Object)
InitializeLifetimeService()
Устаревшие.

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неглубокую копию текущей Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неглубокую копию текущего MarshalByRefObject объекта.

(Унаследовано от MarshalByRefObject)
ResetDbType()

Сбрасывает тип, связанный с этим SqlParameter.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

ResetSqlDbType()

Сбрасывает тип, связанный с этим SqlParameter.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

ToString()

Возвращает строку, содержащую объект ParameterName.

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

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

Имя. Описание
ICloneable.Clone()

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

Для новой разработки используйте Microsoft. Data.SqlClient. На этой странице приведены документы System.Data.SqlClient.

IDataParameter.SourceVersion

Возвращает или задает значение, используемое при загрузке DataRowVersionValue.

(Унаследовано от DbParameter)
IDbDataParameter.Precision

Указывает точность числовых параметров.

(Унаследовано от DbParameter)
IDbDataParameter.Scale

Описание этого элемента см. в разделе Scale.

(Унаследовано от DbParameter)

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

См. также