Поделиться через


SqlParameterCollection Класс

Определение

Представляет коллекцию параметров, относящихся к SqlCommand, а также соответствующие им сопоставления со столбцами в DataSet. Этот класс не наследуется.

public ref class SqlParameterCollection sealed : System::Data::Common::DbParameterCollection
[System.ComponentModel.ListBindable(false)]
public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection
public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection
[<System.ComponentModel.ListBindable(false)>]
type SqlParameterCollection = class
    inherit DbParameterCollection
type SqlParameterCollection = class
    inherit DbParameterCollection
Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection
Наследование
SqlParameterCollection
Атрибуты

Примеры

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

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

    }
}

Комментарии

Если команда содержит нерегламентированные инструкции 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)

Добавляет объект SqlParameter в коллекцию SqlParameterCollection в соответствии с заданным именем и типом данных параметра.

Add(String, SqlDbType, Int32)

Добавляет SqlParameter в SqlParameterCollection, задавая указанные имя параметра, SqlDbType и размер.

Add(String, SqlDbType, Int32, String)

Добавляет объект 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, начиная с указанного индекса в коллекции назначения.

GetEnumerator()

Возвращает перечислитель, осуществляющий перебор элементов списка SqlParameterCollection.

IndexOf(Object)

Возвращает положение указанного объекта Object в коллекции.

IndexOf(SqlParameter)

Возвращает положение указанного объекта SqlParameter в коллекции.

IndexOf(String)

Возвращает положение заданного объекта SqlParameter с указанным именем.

Insert(Int32, Object)

Вставляет объект Object в коллекцию SqlParameterCollection по указанному индексу.

Insert(Int32, SqlParameter)

Вставляет объект SqlParameter в коллекцию SqlParameterCollection по указанному индексу.

Remove(Object)

Удаляет указанный объект SqlParameter из коллекции.

Remove(SqlParameter)

Удаляет указанный объект SqlParameter из коллекции.

RemoveAt(Int32)

Удаляет объект SqlParameter с указанным индексом из коллекции SqlParameterCollection.

RemoveAt(String)

Удаляет объект SqlParameter с указанным именем из коллекции SqlParameterCollection.

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