Skip to content

IAdmSearchResultIterator

The IAdmSearchResultIterator interface provides methods and properties that are used to iterate through search results.

Inheritance: The IAdmSearchResultIterator interface inherits from the IDisposable interface.

Methods

  • Method

  • Description

  • FetchAll()

  • Fetches all results that were found during the search.

  • MoveNext()

  • Advances the search iterator to the next element in the search results.

  • Reset()

  • Moves the iterator to the start of the search results.

  • MovePrevious()

  • Moves the search iterator to the previous element in the search results.

  • AbandonSearch()

  • Abandons the search.

Properties

Details

FetchAll()

Fetches all results that were found during the search.

AdmSearchResult[] FetchAll()

MoveNext()

Advances the search iterator to the next element in the search results.

Boolean MoveNext()

Return value

The method returns TRUE if the iterator successfully moved, and FALSE if the iterator passes the end of the search results.

Remarks

If directory search is performed synchronously, when this method is called for the first time, it waits for all search results to load, and then tries to advance the iterator. If the search is asynchronous, and the method reaches the last element in the collection, it tries to load another portion of data, and only when that portion of data is empty, it returns FALSE.


Reset()

Moves the iterator to the start of the search results.

void Reset()

Remarks

This method can be used only if caching is enabled.


MovePrevious()

Moves the search iterator to the previous element in the search results.

copyBoolean MovePrevious()

Return value

The method returns TRUE if the iterator succeeds, and FALSE if the iterator passes the beginning of the collection.

Remarks

This method can be used only if caching is enabled.


AbandonSearch()

Abandons the search.

void AbandonSearch()

Count

Gets the number of entries in the search result.

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

Current

Gets the current search result entry.


IsSearchCompleted

Gets a value that indicates whether the current search is complete.

  • Type:
  • Boolean
  • Access:
  • Read-only

IsSizeLimitExceeded

Gets a value that indicates whether the size limit was exceeded.

  • Type:
  • Boolean
  • Access:
  • Read-only

IsTimeLimitExceeded

Gets a value that indicates whether the time limit was exceeded.

  • Type:
  • Boolean
  • Access:
  • Read-only

ResultDirectorySynchronization

Gets an instance of the AdmDirectorySynchronization class containing the data that was returned by the directory server.


ResultPagingInfo

Gets a cookie for the next search.


ResultVirtualListView

Gets an instance of the AdmDirectoryVirtualListView class containing the data that was returned by the directory server.


SearchReferences

Gets a collection of search references as returned by the server.

  • Type:
  • ICollection<ICollection<Uri>>
  • Access:
  • Read-only

Requirements

Minimum required version: 2009.1

See also