PrincipalSearcher.GetUnderlyingSearcher Method

Definition

Namespace:

System.DirectoryServices.AccountManagement

Assembly:

System.DirectoryServices.AccountManagement.dll

Package:

System.DirectoryServices.AccountManagement v8.0.0

Source:

PrincipalSearcher.cs

Returns the underlying search object that is used by the Account Management API to perform the search.

public:
 System::Object ^ GetUnderlyingSearcher();

public object GetUnderlyingSearcher ();

member this.GetUnderlyingSearcher : unit -> obj

Public Function GetUnderlyingSearcher () As Object

Returns

Object

A DirectorySearcher object.

Exceptions

InvalidOperationException

A QueryFilter must first be assigned to the principal searcher before the query can be performed.

The QueryFilter contains referential properties. For more information, see the Query by Example overview topic.

The QueryFilter is a persisted principal.

Remarks

The application can modify the properties directly on the DirectorySearcher object before executing the query. The query will then execute using the modified properties. For example, the default page size of 256 KB is used when the PrincipalSearcher class performs a query for Domain principals. The application may override the default value by setting the PageSize property in the underlying DirectorySearcher object that is returned from this method.

See also

• Query by Example