Skip to content

IAdmListItemIterator

The IAdmListItemIterator interface provides methods used to iterate through items in the IAdmListItems list.

Inheritance: The IAdmListItemIterator interface inherits from the IUnknown interface.

Methods

  • Method

  • Description

  • GetNextIDs()

  • Retrieves the specified number of list item IDs and advances the enumeration sequence to the last retrieved ID.

  • GetNext()

  • Retrieves the specified number of list items and advances the enumeration sequence to the last retrieved item.

  • Reset()

  • Resets the enumeration sequence to the beginning of the list.

Details

GetNextIDs()

Retrieves the specified number of list item IDs and advances the enumeration sequence to the last retrieved ID.

Int32[] GetNextIDs(Int32 pageSize)

Parameters

The pageSize parameter specifies the maximum number of IDs to be retrieved. If the parameter is less or equal to zero, the method retrieves IDs of all remaining list items.

Remarks

  • The method returns fewer IDs than requested if the requested number of list items is not fetched.
  • The method returns an empty array if called during list generation and there are no results.
  • The method returns NULL if the list generation is completed and there are no more list items to retrieve.

GetNext()

Retrieves the specified number of list items and advances the enumeration sequence to the last retrieved item.

IAdmListItem[] GetNext(Int32 pageSize)

Parameters

The pageSize parameter specifies the maximum number of list items to be retrieved. If the parameter is less or equal to zero, the method retrieves all remaining list items.

Remarks

  • The method returns fewer list items than requested if the requested number is not fetched.
  • The method returns an empty array if called during list generation and there are no results.
  • The method returns NULL if the list generation is completed and there are no more items to retrieve.

Reset()

Resets the enumeration sequence to the beginning of the list.

void Reset()

Requirements

Minimum required version: 2018.1

See also