PrincipalSearcher PrincipalSearcher PrincipalSearcher PrincipalSearcher Class


Encapsulates the methods and search patterns used to execute a query against the underlying principal store.

public ref class PrincipalSearcher : IDisposable
public class PrincipalSearcher : IDisposable
type PrincipalSearcher = class
    interface IDisposable
Public Class PrincipalSearcher
Implements IDisposable


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 the GetUnderlyingSearcher method.


PrincipalSearcher() PrincipalSearcher() PrincipalSearcher() PrincipalSearcher()

Initializes a new instance of the PrincipalSearcher class. The QueryFilter property must be set before the Principal searcher object can be used to perform a search.

PrincipalSearcher(Principal) PrincipalSearcher(Principal) PrincipalSearcher(Principal) PrincipalSearcher(Principal)

Initializes a new instance of the PrincipalSearcher class with the specified query filter.


Context Context Context Context

Gets that principal context that is used to perform the query. The context specifies the server or domain against which search operations are performed.

QueryFilter QueryFilter QueryFilter QueryFilter

Gets or sets the query filter that is used to locate matching principals.


Dispose() Dispose() Dispose() Dispose()

Disposes the current instance of the PrincipalSearcher object.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindAll() FindAll() FindAll() FindAll()

Returns a principal search result that contains a collection of all the principal objects that match the principal specified in the query filter property.

FindOne() FindOne() FindOne() FindOne()

Returns a principal search result that contains the first principal object found that matches the principal specified in the QueryFilter property.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUnderlyingSearcher() GetUnderlyingSearcher() GetUnderlyingSearcher() GetUnderlyingSearcher()

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

GetUnderlyingSearcherType() GetUnderlyingSearcherType() GetUnderlyingSearcherType() GetUnderlyingSearcherType()

Returns the type of the object returned from the GetUnderlyingSearcher() method.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also