DirectorySearcher.Asynchronous Property

Reference

Definition

Namespace:: System.DirectoryServices

Assembly:: System.DirectoryServices.dll

Package:: System.DirectoryServices v8.0.0

Package:: System.DirectoryServices v9.0.0-rc.2.24473.5

Source:: DirectorySearcher.cs

Source:: DirectorySearcher.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 property bool Asynchronous { bool get(); void set(bool value); };

public bool Asynchronous { get; set; }

[System.DirectoryServices.DSDescription("DSAsynchronous")]
[System.Runtime.InteropServices.ComVisible(false)]
public bool Asynchronous { get; set; }

member this.Asynchronous : bool with get, set

[<System.DirectoryServices.DSDescription("DSAsynchronous")>]
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.Asynchronous : bool with get, set

Public Property Asynchronous As Boolean

Property Value

Boolean

true if the search is asynchronous; false otherwise.

Attributes: DSDescriptionAttribute ComVisibleAttribute

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 src = new DirectorySearcher(entry);  
//Set the Asynchronous property to true.  
src.Asynchronous = true;  
//Use the FindAll method to get search results.  
SearchResultCollection res = src.FindAll();

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.

Applies to

Dela via