DirectorySearcher::Asynchronous Property

.NET Framework (current version)

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

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

Syntax

public:
[DSDescriptionAttribute("DSAsynchronous")]
[ComVisibleAttribute(false)]
property bool Asynchronous {
	bool get();
	void set(bool value);
}

Property Value

Type: System::Boolean

true if the search is asynchronous; false otherwise.

Remarks

An asynchronous search can show results as they are found while simultaneously searching for additional results. This is useful for tasks such as populating list boxes.

The default setting for this property is false.

Examples

The following C# example shows how to create an asynchronous search.

using System.DirectoryServices;
...
// Bind to the users container.
DirectoryEntry entry = new DirectoryEntry("LDAP://CN=users,DC=fabrikam,DC=com");
// Create a DirectorySearcher object.
DirectorySearcher mySearcher = new DirectorySearcher(entry);
//Set the Asynchronous property to true.
src.Asynchronous = true;
//Use the FindAll method to get search results.
SearchResultCollection res = src.FindAll();

Version Information

.NET Framework
Available since 2.0