IAdmDirectorySearcher

The IAdmDirectorySearcher interface provides methods and properties that are used to perform directory searches.

Methods

Properties

  • Property

  • Description

  • Asynchronous

  • Gets or sets a value that indicates whether the search is performed asynchronously.

  • AttributeScopeQuery

  • Gets or sets the LDAP name of the DN-syntax property to search in.

  • CacheResults

  • Gets or sets a value indicating whether search results are cached on the client computer.

  • ClientTimeout

  • Gets or sets the maximum amount of time that the client waits for the server to return results.

  • Criteria

  • Gets or sets the search criteria.

  • DerefAlias

  • Gets or sets a value indicating how aliases of directory objects that are found during the search should be handled.

  • DirectorySynchronization

  • Gets or sets an object that represents a directory synchronization control to be used during the search.

  • ExtendedDN

  • Gets or sets a value that indicates the format of distinguished names.

  • PageSize

  • Gets or sets the page size in a paged search.

  • PagingInfo

  • Gets or sets a value that contains information about a paged search.

  • PropertyNamesOnly

  • Gets or sets a value that indicates whether the directory search retrieves only the names of the properties to which values have been assigned.

  • ReferralChasing

  • Gets or sets a value indicating how referrals are chased during the search.

  • SearchScope

  • Gets or sets a value indicating the scope of the directory search that is observed by the server.

  • SecurityMasks

  • Gets or sets a value indicating which security access information for the specified properties should be returned by the search.

  • ServerTimeLimit

  • Gets or sets a value indicating the maximum amount of time the server spends searching.

  • SizeLimit

  • Gets or sets a value indicating the maximum number of objects that the server returns in the search.

  • Sort

  • Gets or sets a value indicating the property by which the results are sorted.

  • Tombstone

  • Gets or sets a value indicating whether the search should also return deleted objects that match the search filter.

  • VirtualListView

  • Gets or sets a value indicating the virtual list view options for the search.

  • VirtualRoot

  • Gets or sets a value indicating whether the virtual root is used for the search.

Details

GetPropertiesToLoad()

Gets a list of properties to be fetched during the directory search.

string[] GetPropertiesToLoad()

SetPropertiesToLoad()

Sets a list of properties to be fetched during the directory search.

void SetPropertiesToLoad(string[] properties)

Parameters

The properties parameter is an array containing a list of properties to be retrieved during the directory search.

ResetSearchParameters()

Resets search parameters to default values.

void ResetSearchParameters()

ExecuteSearch()

Executes the directory search and returns the IAdmSearchResultIterator interface that can further be used to iterate through search results.

IAdmSearchResultIterator ExecuteSearch()

Asynchronous

Gets or sets a value that indicates whether the search is performed asynchronously.

  • Type:
  • bool
  • Access:
  • Read/Write

AttributeScopeQuery

Gets or sets the LDAP name of the DN-syntax property to search in. Only one property can be used for this type of search.

  • Type:
  • string
  • Access:
  • Read/Write

CacheResults

Gets or sets a value indicating whether search results are cached on the client computer.

  • Type:
  • string
  • Access:
  • Read/Write

ClientTimeout

Gets or sets the maximum amount of time that the client waits for the server to return results. If the server does not respond within the time specified, the search is aborted, and no results are returned.

  • Type:
  • TimeSpan
  • Access:
  • Read/Write

Criteria

Gets or sets the search criteria. For details about building search criteria, see How to build criteria.

DerefAlias

Gets or sets a value indicating how aliases of directory objects that are found during the search should be handled.

DirectorySynchronization

Gets or sets an object that represents a directory synchronization control to be used during the search.

ExtendedDN

Gets or sets a value that indicates the format of distinguished names.

PageSize

Gets or sets the page size in a paged search.

  • Type:
  • int
  • Access:
  • Read/Write

PagingInfo

Gets or sets a value that contains information about a paged search.

Remarks

Since virtual list view search is not supported by the Windows 2000 server, there is a need to have the ability to get a particular page. That can be implemented using the PageSize property by fetching all results until the requested search page is reached, however this is too expensive. Usage of this property prevents unnecessary passing of all search results through the pipeline.

PropertyNamesOnly

Gets or sets a value that indicates whether the directory search retrieves only the names of the properties to which values have been assigned.

  • Type:
  • bool
  • Access:
  • Read/Write

ReferralChasing

Gets or sets a value indicating how referrals are chased during the search.

SearchScope

Gets or sets a value indicating the scope of the directory search that is observed by the server.

SecurityMasks

Gets or sets a value indicating which security access information for the specified properties should be returned by the search.

ServerTimeLimit

Gets or sets a value indicating the maximum amount of time the server spends searching. If the time limit is reached, only entries that are found up to that point are returned.

  • Type:
  • TimeSpan
  • Access:
  • Read/Write

SizeLimit

Gets or sets a value indicating the maximum number of objects that the server returns in the search.

  • Type:
  • int
  • Access:
  • Read/Write

Sort

Gets or sets a value indicating the property by which the results are sorted.

Tombstone

Gets or sets a value indicating whether the search should also return deleted objects that match the search filter.

  • Type:
  • bool
  • Access:
  • Read/Write

VirtualListView

Gets or sets a value indicating the virtual list view options for the search.

VirtualRoot

Gets or sets a value indicating whether the virtual root is used for the search. Using the virtual root means that the search is performed in all the domains that are registered in Adaxes. The only value of the SearchScope property that can be used with the virtual root is ADS_SCOPE_SUBTREE.

  • Type:
  • bool
  • Access:
  • Read/Write

Requirements

Minimum required version: 2023

See also

© Softerra 2022. All rights reserved.
Send feedback