The IDL_Container::Remove procedure method removes an item from the container.

Syntax

---

Obj->[IDL_Container::]Remove [, Heapvar] [, POSITION=index] [, /ALL]

Arguments

---

Heapvar

A scalar or array of heap variables (object references or pointers) to be removed. If Heapvar is not provided (and neither the ALL nor POSITION keyword are set), the first item in the container will be removed. If Heapvar is !NULL then nothing is removed and the method quietly returns.

Keywords

---

ALL

Set this keyword to remove all items from the container. If this keyword is set, the Heapvar argument is not required.

POSITION

Set this keyword equal to the zero-based index of the item to be removed. If theHeapvar argument is supplied, this keyword is ignored.

Version History

---

5.0	Introduced
8.2	Allow !NULL as an input argument
8.4	Add support for pointers within containers

See Also

---

IDL_Container::Add, IDL_Container::Count, IDL_Container::Equals, IDL_Container::Get, IDL_Container::IsContained, IDL_Container::Move