Метод Remove (объект Collection)

Обновлен: Ноябрь 2007

Удаляет элемент из объекта Collection.

Public Overloads Sub Remove(_
    ByVal { Key As String | Index As Integer } _
)

Параметры

  • Key
    Уникальное выражение типа String, определяющее строковый ключ, который может использоваться вместо позиционного индекса для доступа к элементу коллекции. Параметр Key должен соответствовать аргументу Key, заданному при добавлении элемента в коллекцию.

  • Index
    Числовое выражение, задающее позицию элемента коллекции. Параметр Index должен иметь значение от 1 до значения Свойство Count (объект Collection) коллекции.

Исключения

Тип исключения

Номер ошибки

Условия

ArgumentException

5

Параметр Key имеет недопустимое значение или не указан.

IndexOutOfRangeException

9

Значение параметра Index не соответствует существующему элементу коллекции.

См. столбец "Номер ошибки", если выполняется обновление приложений Visual Basic 6.0, в которых используется неструктурированная обработка ошибок. (Можно сравнить номер ошибки с Свойство Number (объект Err).) Однако по возможности следует заменять такую систему управления ошибками на Обзор структурной обработки исключений в Visual Basic.

Заметки

При удалении элемента из коллекции с помощью метода RemoveСвойство Count (объект Collection) коллекции уменьшается на единицу. При этом также уменьшается значение Index каждого элемента, следующего за удаленным элементом коллекции.

Если элемент был добавлен в коллекцию без свойства Key, для удаления такого элемента необходимо использовать его свойство Index.

Пример

В этом примере иллюстрируется использование метода Remove для удаления объектов из Объект Collection (Visual Basic) переменной birthdays.

Dim birthdays As New Collection()
birthdays.Add(New DateTime(2001, 1, 12), "Bill")
birthdays.Add(New DateTime(2001, 1, 13), "Joe")
birthdays.Add(New DateTime(2001, 1, 14), "Mike")
birthdays.Add(New DateTime(2001, 1, 15), "Pete")


...


birthdays.Remove(1)
birthdays.Remove("Mike")

После четырех вызовов метода Add свойство Count будет содержать значение 4, элемент "Bill" будет иметь значения индекса 1, а элемент "Pete" — значение индекса 4.

После первого вызова метода Remove свойство Count будет содержать значение 3, элемент "Bill" удаляется, а элемент "Pete" будет имеет значение индекса 3.

После второго вызова метода Remove свойство Count будет иметь значение 2, элемент "Mike" удаляется, а элемент "Pete" будет имеет значение индекса 2.

Требования

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

Модуль: Collection

Сборка: Visual Basic (библиотека времени выполнения, в Microsoft.VisualBasic.dll)

См. также

Ссылки

Объект Collection (Visual Basic)

Метод Add (объект Collection)