SearchRequest Class

The SearchRequest class initiates a search operation.

Namespace:  System.DirectoryServices.Protocols
Assembly:  System.DirectoryServices.Protocols (in System.DirectoryServices.Protocols.dll)

public class SearchRequest : DirectoryRequest

The SearchRequest type exposes the following members.

  NameDescription
Public methodSearchRequest()The SearchRequest() constructor creates an instance of the SearchRequest class. This constructor creates an empty request.
Public methodSearchRequest(String, String, SearchScope, String[])The SearchRequest(String, String, SearchScope, String[]) constructor creates an instance of the SearchRequest class using the specified name, search filter, scope, and attributes.
Public methodSearchRequest(String, XmlDocument, SearchScope, String[])The SearchRequest(String, XmlDocument, SearchScope, String[]) constructor creates an instance of the SearchRequest class using the specified name, search filter, scope, and attributes.
Top

  NameDescription
Public propertyAliasesThe Aliases property contains one of the values of DereferenceAlias that specifies the dereference alias behavior.
Public propertyAttributesThe Attributes property contains the attributes of the requested object.
Public propertyControlsThe Controls property contains a DirectoryControlCollection object. (Inherited from DirectoryRequest.)
Public propertyDistinguishedNameThe DistinguishedName property contains the distinguished name of the requested object.
Public propertyFilterThe Filter property contains the search filter.
Public propertyRequestIdThe RequestId property contains the requestID specified in the request. (Inherited from DirectoryRequest.)
Public propertyScopeThe Scope property contains one of the values of SearchScope that specifies the scope of the search.
Public propertySizeLimitThe SizeLimit property contains the maximum number of objects returned in the search request.
Public propertyTimeLimitThe TimeLimit property contains a TimeSpan object that specifies the time span allowed, if the server processes the search request.
Public propertyTypesOnlyThe TypesOnly property specifies whether the search returns only the attribute names and not the attribute values.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodToXmlNodeThe ToXmlNode method creates an XML node from the specified XmlDocument object. (Overrides DirectoryRequest.ToXmlNode(XmlDocument).)
Top

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft