SqlParameterCollection Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет коллекцию параметров, связанных с aSqlCommand, и их соответствующие сопоставления со столбцами в .DataSet Этот класс не наследуется.
public ref class SqlParameterCollection sealed : System::Data::Common::DbParameterCollection
public ref class SqlParameterCollection sealed : MarshalByRefObject, System::Collections::IList, System::Data::IDataParameterCollection
public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection
[System.ComponentModel.ListBindable(false)]
public sealed class SqlParameterCollection : MarshalByRefObject, System.Collections.IList, System.Data.IDataParameterCollection
[System.ComponentModel.ListBindable(false)]
public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection
type SqlParameterCollection = class
inherit DbParameterCollection
[<System.ComponentModel.ListBindable(false)>]
type SqlParameterCollection = class
inherit MarshalByRefObject
interface IDataParameterCollection
interface IList
interface ICollection
interface IEnumerable
[<System.ComponentModel.ListBindable(false)>]
type SqlParameterCollection = class
inherit DbParameterCollection
Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection
Public NotInheritable Class SqlParameterCollection
Inherits MarshalByRefObject
Implements IDataParameterCollection, IList
- Наследование
- Наследование
- Наследование
- Атрибуты
- Реализации
Примеры
В следующем примере создается несколько экземпляров SqlParameter коллекции SqlParameterCollection . Параметры используются для выбора данных в источнике данных и заполнения DataSet. В этом коде предполагается, что уже DataSet создано и SqlDataAdapter уже создано с соответствующей схемой, командами и подключением.
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
Комментарии
Если команда содержит нерегламентированный оператор SQL, а не имя хранимой процедуры, число параметров в коллекции должно быть равно числу заполнителей параметров в тексте команды или SQL Server вызывает ошибку. При использовании хранимой процедуры все параметры, объявленные в хранимой процедуре без значения по умолчанию, должны быть предоставлены. Параметры, объявленные со значением по умолчанию, являются необязательными. Это позволяет указать значение, отличное от значения по умолчанию.
Дополнительные сведения с дополнительным примером кода, демонстрирующего использование параметров, см. в разделе "Команды и параметры".
Свойства
| Имя | Описание |
|---|---|
| Count |
Возвращает целое число, содержащее количество элементов в элементе SqlParameterCollection. Только для чтения. |
| IsFixedSize |
Возвращает значение, указывающее, имеет ли SqlParameterCollection размер фиксированного размера. |
| IsReadOnly |
Возвращает значение, указывающее, доступен ли доступ SqlParameterCollection только для чтения. |
| IsSynchronized |
Возвращает значение, указывающее, синхронизирован ли он SqlParameterCollection . |
| Item[Int32] |
Возвращает указанный SqlParameter индекс. |
| Item[String] |
Возвращает указанное SqlParameter имя. |
| SyncRoot |
Получает объект, который можно использовать для синхронизации доступа к объекту SqlParameterCollection. |
Методы
| Имя | Описание |
|---|---|
| Add(Object) |
Добавляет указанный SqlParameter объект в SqlParameterCollectionобъект . |
| Add(SqlParameter) |
Добавляет указанный SqlParameter объект в SqlParameterCollectionобъект . |
| Add(String, Object) |
Устаревшие..
Добавляет указанный SqlParameter объект в SqlParameterCollectionобъект . |
| Add(String, SqlDbType, Int32, String) |
Добавляет к SqlParameterSqlParameterCollection имени параметра, типу данных и длине столбца. |
| Add(String, SqlDbType, Int32) |
Добавляется в SqlParameterSqlParameterCollectionпараметр с заданным именем SqlDbType параметра и размером. |
| Add(String, SqlDbType) |
Добавляет значение SqlParameter к заданному SqlParameterCollection имени параметра и типу данных. |
| AddRange(Array) |
Добавляет массив значений в конец SqlParameterCollection. |
| AddRange(SqlParameter[]) |
Добавляет массив значений SqlParameter в конец SqlParameterCollection. |
| AddWithValue(String, Object) |
Добавляет значение в конец SqlParameterCollection. |
| Clear() |
Удаляет все SqlParameter объекты из .SqlParameterCollection |
| Contains(Object) |
Определяет, находится ли указанный Object в этом SqlParameterCollectionпараметре. |
| Contains(SqlParameter) |
Определяет, находится ли указанный SqlParameter в этом SqlParameterCollectionпараметре. |
| Contains(String) |
Определяет, находится ли указанное имя параметра в этом SqlParameterCollectionпараметре. |
| CopyTo(Array, Int32) |
Копирует все элементы текущего SqlParameterCollection в указанный одномерный Array индекс, начиная с указанного целевого Array индекса. |
| CopyTo(SqlParameter[], Int32) |
Копирует все элементы текущего SqlParameterCollection в указанный SqlParameterCollection начиная с указанного целевого индекса. |
| CreateObjRef(Type) |
Создает объект, содержащий все соответствующие сведения, необходимые для создания прокси-сервера, используемого для взаимодействия с удаленным объектом. (Унаследовано от MarshalByRefObject) |
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| GetEnumerator() |
Возвращает перечислитель, который выполняет итерацию через SqlParameterCollection. |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetLifetimeService() |
Устаревшие..
Извлекает текущий объект службы времени существования, который управляет политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject) |
| GetParameter(Int32) |
DbParameter Возвращает объект по указанному индексу в коллекции. (Унаследовано от DbParameterCollection) |
| GetParameter(String) |
Возвращает DbParameter объект с указанным именем. (Унаследовано от DbParameterCollection) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| IndexOf(Object) |
Возвращает расположение указанного Object в коллекции. |
| IndexOf(SqlParameter) |
Возвращает расположение указанного SqlParameter в коллекции. |
| IndexOf(String) |
Возвращает расположение указанного SqlParameter с указанным именем. |
| InitializeLifetimeService() |
Устаревшие..
Получает объект службы времени существования для управления политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject) |
| Insert(Int32, Object) |
Вставляет объект Object в SqlParameterCollection указанный индекс. |
| Insert(Int32, SqlParameter) |
Вставляет SqlParameter объект в SqlParameterCollection указанный индекс. |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| MemberwiseClone(Boolean) |
Создает неглубокую копию текущего MarshalByRefObject объекта. (Унаследовано от MarshalByRefObject) |
| Remove(Object) |
Удаляет указанный SqlParameter из коллекции. |
| Remove(SqlParameter) |
Удаляет указанный SqlParameter из коллекции. |
| RemoveAt(Int32) |
Удаляется SqlParameter из указанного SqlParameterCollection индекса. |
| RemoveAt(String) |
SqlParameter Удаляется из указанного SqlParameterCollection имени параметра. |
| SetParameter(Int32, DbParameter) |
DbParameter Задает объект по указанному индексу новое значение. (Унаследовано от DbParameterCollection) |
| SetParameter(String, DbParameter) |
DbParameter Задает объекту с указанным именем новое значение. (Унаследовано от DbParameterCollection) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Явные реализации интерфейса
| Имя | Описание |
|---|---|
| ICollection.IsSynchronized |
Возвращает значение, указывающее, синхронизирован ли доступ к ICollection (потокобезопасный). (Унаследовано от DbParameterCollection) |
| IDataParameterCollection.Item[String] |
Возвращает или задает параметр по указанному индексу. (Унаследовано от DbParameterCollection) |
| IList.IsFixedSize |
Возвращает значение, указывающее, имеет ли IList размер фиксированного размера. (Унаследовано от DbParameterCollection) |
| IList.IsReadOnly |
Возвращает значение, указывающее, доступен ли доступ IList только для чтения. (Унаследовано от DbParameterCollection) |
| IList.Item[Int32] |
Возвращает или задает элемент по указанному индексу. (Унаследовано от DbParameterCollection) |
Методы расширения
| Имя | Описание |
|---|---|
| AsParallel(IEnumerable) |
Включает параллелизацию запроса. |
| AsQueryable(IEnumerable) |
Преобразует IEnumerable в IQueryable. |
| Cast<TResult>(IEnumerable) |
Приведение элементов IEnumerable к указанному типу. |
| OfType<TResult>(IEnumerable) |
Фильтрует элементы IEnumerable на основе указанного типа. |