This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!
DirectorySearcher Members
Public:
Constructor
Properties
CacheResults |
Specifies whether the result should be cached on the client machine. By default, ADSI caches the result set. Turning off this option may be more desirable for large result sets. |
ClientTimeout |
The maximum amount of time the client will wait for the server to return results. If the server does not respond within this time, the search will be aborted, and no results will be returned. |
Filter |
The Filter property is a single string conforming to RFC2254, which specifies the LDAP filter string format. It uses prefix notation to combine qualifications (though "=" is still infix). For example, The default value is "(objectClass=*)", which retrieves all objects. |
PageSize |
Instructs the server to perform a paged search. Once the server has found PageSize objects, it will stop searching and return the results to the client. When the client requests more data, the server will restart the search where it left off. Default is-1, which means do not page. |
PropertiesToLoad |
The set of properties to be retrieved with the search. By default, the Path and Name properties are retrieved. |
PropertyNamesOnly |
UNDONE, stefanph: If they're not excluded, what do you get?! |
ReferralChasing |
Specifies how (and whether) referrals are chased. |
SearchRoot |
The node in the Active Directory hierarchy at which the search will start. |
SearchScope |
Determines the scope of the search. Default is SearchScope.Subtree. |
ServerPageTimeLimit |
Specifies the time limit that the server should observe to search a page of results (as opposed to the time limit for the entire search). Set to a negative value for no time limit. This property applies only to searches where PageSize has been set to something other than the default. |
ServerTimeLimit |
The maximum amount of time the server will spend searching. If the time limit is reached, only entries found up to that point will be returned. Set to a negative value to use the server-determined default. |
Site (inherited from Component) |
Gets or sets the site of the Component. |
SizeLimit |
The maximum number of entries the server will find before returning. If the size limit is reached, only entries found up to that point will be returned. Specify-1 to use the server-determined default size limit. |
Sort |
Allows you to set a property on which the results should be sorted. |
Methods
Dispose (inherited from Component) |
Disposes of the Component. |
Equals (inherited from Object) |
Determines whether the specified Object is the same instance as the current Object. Subclasses are expected to override this method to support value equality (not reference equality). |
FindAll |
Executes the search. A collection of results is returned that you can iterate over. |
FindOne |
Executes the search. If the search returns more than one entry, only the first one is returned. If no entries were find matching the search criteria, null is returned. |
GetContainer (inherited from Component) |
Returns the IContainer that contains the Component. |
GetDesignMode (inherited from Component) |
Gets a value indicating whether the Component is currently in design mode. |
GetHashCode (inherited from Object) |
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
GetServiceObject (inherited from Component) |
Returns an object representing a service provided by the Component. |
GetType (inherited from Object) |
Gets the Type of the Object. |
ToString (inherited from Component) |
Returns a String containing the name of the Component, if any. This method should not be overridden. For internal use only. |
Protected:
Methods
Finalize (inherited from Object) |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by the Garbage Collector (GC). This method may be ignored by the runtime; therefore, necessary cleanup operations should be done elsewhere. |
MemberwiseClone (inherited from Object) |
Creates a shallow copy of the current Object. |
See Also
DirectorySearcher Class | System.DirectoryServices Namespace