SqlParameterCollection Class

Definition

Представляет коллекцию параметров, относящихся к SqlCommand, а также соответствующие им сопоставления со столбцами в DataSet.Represents a collection of parameters associated with a SqlCommand and their respective mappings to columns in a DataSet. Этот класс не наследуется.This class cannot be inherited.

public ref class SqlParameterCollection sealed : System::Data::Common::DbParameterCollection
public ref class SqlParameterCollection sealed : MarshalByRefObject, System::Collections::IList, System::Data::IDataParameterCollection
public ref class SqlParameterCollection sealed : System::Data::Common::DbParameterCollection, System::Collections::IList
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
[System.ComponentModel.ListBindable(false)]
public sealed class SqlParameterCollection : System.Data.Common.DbParameterCollection, System.Collections.IList
type SqlParameterCollection = class
    inherit DbParameterCollection
type SqlParameterCollection = class
    inherit MarshalByRefObject
    interface IDataParameterCollection
    interface IList
    interface ICollection
    interface IEnumerable
type SqlParameterCollection = class
    inherit DbParameterCollection
    interface IDataParameterCollection
    interface IList
    interface ICollection
    interface IEnumerable
Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection
Public NotInheritable Class SqlParameterCollection
Inherits MarshalByRefObject
Implements IDataParameterCollection, IList
Public NotInheritable Class SqlParameterCollection
Inherits DbParameterCollection
Implements IList
Inheritance
SqlParameterCollection
Inheritance
Inheritance
SqlParameterCollection
Attributes
Implements

Examples

В следующем примере создается несколько экземпляров SqlParameter через коллекцию SqlParameterCollection.The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection. Параметры используются для выбора данных в источнике данных и заполнения DataSet.The parameters are used to select data within the data source and populate the DataSet. В этом коде предполагается, что DataSet и SqlDataAdapter уже созданы с соответствующей схемой, командами и соединением.This code assumes that a DataSet and a SqlDataAdapter have already been created with the appropriate schema, commands, and connection.

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  

Remarks

Если команда содержит нерегламентированную инструкцию SQL, а не имя хранимой процедуры, число параметров в коллекции должно быть равно числу заполнителей параметров в тексте команды, или SQL Server вызывает ошибку.If the command contains an ad hoc SQL statement, as opposed to a stored-procedure name, the number of the parameters in the collection must be equal to the number of parameter placeholders within the command text, or SQL Server raises an error. При использовании хранимой процедуры необходимо указать все параметры, объявленные в хранимой процедуре без значения по умолчанию.With a stored procedure, all the parameters declared in the stored procedure without a default value must be provided. Параметры, объявленные со значением по умолчанию, являются необязательными.Parameters declared with a default value are optional. Это позволяет указать значение, отличное от значения по умолчанию.This lets you specify a value other than the default.

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

Properties

Count

Возвращает целое число, которое содержит количество элементов в SqlParameterCollection.Returns an Integer that contains the number of elements in the SqlParameterCollection. Только для чтения.Read-only.

IsFixedSize

Возвращает значение, показывающее, имеет ли объект SqlParameterCollection фиксированный размер.Gets a value that indicates whether the SqlParameterCollection has a fixed size.

IsFixedSize

Указывает, имеет ли коллекция фиксированный размер.Specifies whether the collection is a fixed size.

(Inherited from DbParameterCollection)
IsReadOnly

Возвращает значение, которое определяет, является ли коллекция SqlParameterCollection доступной только для чтения.Gets a value that indicates whether the SqlParameterCollection is read-only.

IsReadOnly

Указывает, является ли коллекция доступной только для чтения.Specifies whether the collection is read-only.

(Inherited from DbParameterCollection)
IsSynchronized

Возвращает значение, которое определяет, является ли коллекция SqlParameterCollection синхронизированной.Gets a value that indicates whether the SqlParameterCollection is synchronized.

IsSynchronized

Указывает, является ли коллекция синхронизированной.Specifies whether the collection is synchronized.

(Inherited from DbParameterCollection)
Item[Int32]

Возвращает объект SqlParameter по указанному индексу.Gets the SqlParameter at the specified index.

Item[String]

Возвращает объект SqlParameter с указанным именем.Gets the SqlParameter with the specified name.

SyncRoot

Получает объект, с помощью которого можно синхронизировать доступ к коллекции SqlParameterCollection.Gets an object that can be used to synchronize access to the SqlParameterCollection.

Methods

Add(Object)

Добавляет указанный объект SqlParameter в коллекцию SqlParameterCollection.Adds the specified SqlParameter object to the SqlParameterCollection.

Add(SqlParameter)

Добавляет указанный объект SqlParameter в коллекцию SqlParameterCollection.Adds the specified SqlParameter object to the SqlParameterCollection.

Add(String, Object)

Добавляет указанный объект SqlParameter в коллекцию SqlParameterCollection.Adds the specified SqlParameter object to the SqlParameterCollection.

Add(String, SqlDbType)

Добавляет объект SqlParameter в коллекцию SqlParameterCollection в соответствии с заданным именем и типом данных параметра.Adds a SqlParameter to the SqlParameterCollection given the parameter name and the data type.

Add(String, SqlDbType, Int32)

Добавляет SqlParameter в SqlParameterCollection, задавая указанные имя параметра, SqlDbType и размер.Adds a SqlParameter to the SqlParameterCollection, given the specified parameter name, SqlDbType and size.

Add(String, SqlDbType, Int32, String)

Добавляет объект SqlParameter в коллекцию SqlParameterCollection в соответствии с заданным именем параметра, типом данных и длиной столбца.Adds a SqlParameter to the SqlParameterCollection with the parameter name, the data type, and the column length.

AddRange(Array)

Добавляет массив значений в конец коллекции SqlParameterCollection.Adds an array of values to the end of the SqlParameterCollection.

AddRange(SqlParameter[])

Добавляет массив значений SqlParameter в конец коллекции SqlParameterCollection.Adds an array of SqlParameter values to the end of the SqlParameterCollection.

AddWithValue(String, Object)

Добавляет значение в конец коллекции SqlParameterCollection.Adds a value to the end of the SqlParameterCollection.

Clear()

Удаляет все объекты SqlParameter из коллекции SqlParameterCollection.Removes all the SqlParameter objects from the SqlParameterCollection.

Contains(Object)

Определяет, находится ли заданный объект Object в этой коллекции SqlParameterCollection.Determines whether the specified Object is in this SqlParameterCollection.

Contains(SqlParameter)

Определяет, находится ли заданный объект SqlParameter в этой коллекции SqlParameterCollection.Determines whether the specified SqlParameter is in this SqlParameterCollection.

Contains(String)

Определяет, находится ли заданное имя параметра в этой коллекции SqlParameterCollection.Determines whether the specified parameter name is in this SqlParameterCollection.

CopyTo(Array, Int32)

Копирует все элементы текущей коллекции SqlParameterCollection в указанный одномерный массив Array, начиная с указанного индекса в массиве Array.Copies all the elements of the current SqlParameterCollection to the specified one-dimensional Array starting at the specified destination Array index.

CopyTo(SqlParameter[], Int32)

Копирует все элементы текущей коллекции SqlParameterCollection в указанную коллекцию SqlParameterCollection, начиная с указанного индекса в коллекции назначения.Copies all the elements of the current SqlParameterCollection to the specified SqlParameterCollection starting at the specified destination index.

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)

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

(Inherited from Object)
GetEnumerator()

Возвращает перечислитель, осуществляющий перебор элементов списка SqlParameterCollection.Returns an enumerator that iterates through the SqlParameterCollection.

GetHashCode()

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

(Inherited from Object)
GetLifetimeService()

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

(Inherited from MarshalByRefObject)
GetParameter(Int32)

Возвращает объект DbParameter по указанному индексу в коллекции.Returns the DbParameter object at the specified index in the collection.

(Inherited from DbParameterCollection)
GetParameter(String)

Возвращает объект DbParameter с заданным именем.Returns DbParameter the object with the specified name.

(Inherited from DbParameterCollection)
GetType()

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

(Inherited from Object)
IndexOf(Object)

Возвращает положение указанного объекта Object в коллекции.Gets the location of the specified Object within the collection.

IndexOf(SqlParameter)

Возвращает положение указанного объекта SqlParameter в коллекции.Gets the location of the specified SqlParameter within the collection.

IndexOf(String)

Возвращает положение заданного объекта SqlParameter с указанным именем.Gets the location of the specified SqlParameter with the specified name.

InitializeLifetimeService()

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

(Inherited from MarshalByRefObject)
Insert(Int32, Object)

Вставляет объект Object в коллекцию SqlParameterCollection по указанному индексу.Inserts an Object into the SqlParameterCollection at the specified index.

Insert(Int32, SqlParameter)

Вставляет объект SqlParameter в коллекцию SqlParameterCollection по указанному индексу.Inserts a SqlParameter object into the SqlParameterCollection at the specified index.

MemberwiseClone()

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

(Inherited from Object)
MemberwiseClone(Boolean)

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

(Inherited from MarshalByRefObject)
Remove(Object)

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

Remove(SqlParameter)

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

RemoveAt(Int32)

Удаляет объект SqlParameter с указанным индексом из коллекции SqlParameterCollection.Removes the SqlParameter from the SqlParameterCollection at the specified index.

RemoveAt(String)

Удаляет объект SqlParameter с указанным именем из коллекции SqlParameterCollection.Removes the SqlParameter from the SqlParameterCollection at the specified parameter name.

SetParameter(Int32, DbParameter)

Задает новое значение для объекта DbParameter по указанному индексу.Sets the DbParameter object at the specified index to a new value.

(Inherited from DbParameterCollection)
SetParameter(String, DbParameter)

Назначает новое значение объекту DbParameter с указанным именем.Sets the DbParameter object with the specified name to a new value.

(Inherited from DbParameterCollection)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

ICollection.IsSynchronized (Inherited from DbParameterCollection)
IDataParameterCollection.Item[String]

Возвращает или задает параметр по указанному индексу.Gets or sets the parameter at the specified index.

(Inherited from DbParameterCollection)
IList.IsFixedSize (Inherited from DbParameterCollection)
IList.IsReadOnly (Inherited from DbParameterCollection)
IList.Item[Int32]

Возвращает или задает элемент по указанному индексу.Gets or sets the element at the specified index.

(Inherited from DbParameterCollection)

Extension Methods

Cast<TResult>(IEnumerable)

Приводит элементы объекта IEnumerable к заданному типу.Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

Выполняет фильтрацию элементов объекта IEnumerable по заданному типу.Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

Позволяет осуществлять параллельный запрос.Enables parallelization of a query.

AsQueryable(IEnumerable)

Преобразовывает коллекцию IEnumerable в объект IQueryable.Converts an IEnumerable to an IQueryable.

Applies to

See also