SearchResultCollection.Handle Property

Definition

Namespace:

System.DirectoryServices

Assembly:

System.DirectoryServices.dll

Package:

System.DirectoryServices v9.0.0-rc.2.24473.5

Source:

SearchResultCollection.cs

Gets the handle that is returned by the IDirectorySearch::ExecuteSearch method that performs the actual search. For more information, see the IDirectorySearch::ExecuteSearch article.

public:
 property IntPtr Handle { IntPtr get(); };

public IntPtr Handle { get; }

member this.Handle : nativeint

Public ReadOnly Property Handle As IntPtr

Property Value

IntPtr

nativeint

The ADS_SEARCH_HANDLE value that this collection uses.

Remarks

The DirectorySearcher that created this collection calls the IDirectorySearch::ExecuteSearch method, which makes the query results available to the SearchResultCollection object. For more information, see the IDirectorySearch::ExecuteSearch article.

Each time that a query is performed, a handle for the results of that query is associated with its SearchResultCollection object. This handle corresponds to the search handle in ADSI. This handle persists until you call the Dispose() method on the SearchResultCollection object, so you must call Dispose() to prevent a memory leak. The garbage collector does not free memory for this particular object.