Skip to content

IAdmCollection

The IAdmCollection interface represents a collection of directory objects. When you modify the collection, the changes are persisted to the directory immediately.

Inheritance: The IAdmCollection interface inherits from the IEnumerable interface.

Methods

  • Method

  • Description

  • Add()

  • Adds a new item to the collection.

  • Clear()

  • Removes all items from the collection.

  • ClearCache()

  • Clears cached items.

  • Create()

  • Creates a new item that can be added to the collection.

  • CreateEx()

  • Creates a new directory object of the class specified that can be added to the collection.

  • GetEnumerator()

  • Retrieves an enumerator object for this collection object.

  • GetObject()

  • Gets an item by index.

  • Remove()

  • Removes the specified item from the collection.

  • UpdateItems()

  • Updates the collection with the items specified.

Properties

  • Property

  • Description

  • Count

  • Gets the number of items in the collection.

Details

Add()

Adds a new item to the collection.

void Add(IAdmTop itemToAdd)

Clear()

Removes all items from the collection.

void Clear()

ClearCache()

Clears cached items.

void ClearCache()

Create()

Creates a new item that can be added to the collection.

IAdmTop Create()

CreateEx()

Creates a new directory object of the class specified that can be added to the collection.

IAdmTop CreateEx(String objectClass)

Parameters

The objectClass parameter specifies the class of the object to create. This parameter must be set to a string that contains the name of an object class as defined in the directory schema (e.g. “user”, “group”, “adm-SetPropertiesAction”).


GetEnumerator()

Retrieves an enumerator object for this collection object. The enumerator object implements the IEnumerator interface that can be used to enumerate objects in foreach loops.

IEnumerator GetEnumerator()

GetObject()

Gets an item by index.

IAdmTop GetObject(Int32 index)

Remove()

Removes the specified item from the collection.

void Remove(IAdmTop itemToRemove)

UpdateItems()

Updates the collection with the specified items.

void UpdateItems(Object[] itemsToUpdate)

Parameters

The itemsToUpdate parameter must contain an array of IADs interfaces.

Remarks

  • If a directory object from the itemsToUpdate array does not exist in the collection, it will be added to the collection.
  • If a directory object from the itemsToUpdate array exists in the collection, it will be updated.
  • If a directory object exists in the collection, but is not present in the itemsToUpdate array, it will be removed from the collection.

Count

Gets the number of items in the collection.

  • Type:
  • Int32
  • Access:
  • Read-only

Requirements

Minimum required version: 2009.1

See also