SearchResult
The SearchResult class encapsulates a node in the Active Directory hierarchy that is returned during a search through DirectorySearcher.
The SearchResult class is derived from the System.Object class.
Public Methods
The SearchResult class has the following public methods.
| Method | Description |
|---|---|
| Equals(Object) | Determines whether the specified Object is equal to the current Object. |
| GetDirectoryEntry() | Retrieves the DirectoryEntry that corresponds to the SearchResult, from the Active Directory hierarchy. |
| GetHashCode() | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
| GetType() | Gets the Type of the current instance. |
| ToString() |
Public Properties
The SearchResult class has the following public properties.
| Property | Description |
|---|---|
| Path | Data type: String Access type: Read-only Gets the path for this SearchResult. |
| Properties | Data type: ResultPropertyCollection Access type: Read-only Gets a ResultPropertyCollection of properties set on this object. |
Protected Methods
The SearchResult class has the following protected methods.
| Method | Description |
|---|---|
| Finalize() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. |
| MemberwiseClone() | Creates a shallow copy of the current Object. |
Remarks
Instances of SearchResult are very similar to instances of DirectoryEntry. The notable difference is that DirectoryEntry retrieves its information from the Active Directory hierarchy each time a new object is accessed, whereas the data for SearchResult is already available in the SearchResultCollection returned from a query performed with DirectorySearcher. Only those properties that are specified through the DirectorySearcher.PropertiesToLoad property's collection in your query will be available from SearchResult.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Example Code [Visual Basic .NET]
The following example creates a new DirectoryEntry with the search criteria and uses the FindOne method to initiate the search. The search result is stored in GetDirectoryEntry, where the example then retrieve and parse the search result from.
Imports System
Imports System.DirectoryServices
Imports Microsoft.VisualBasic
Public Class MySample
Public Shared Sub Main()
Dim myLDAPPath As String = ""
Try
' Create a 'DirectoryEntry' object to search.
Console.WriteLine("Enter the path ( Ex : 'LDAP://MyServer')")
myLDAPPath = Console.ReadLine()
Dim mySearchRoot As New DirectoryEntry(myLDAPPath)
Dim myDirectorySearcher As New DirectorySearcher(mySearchRoot)
' Get the first entry of the search.
Dim mySearchResult As SearchResult = myDirectorySearcher.FindOne()
If Not (mySearchResult Is Nothing) Then
' Get the 'DirectoryEntry' that corresponds to 'mySearchResult'.
Dim myDirectoryEntry As DirectoryEntry = mySearchResult.GetDirectoryEntry()
Console.WriteLine(ControlChars.Newline + "The name of the 'myDirectoryEntry' " + _
"directory entry that corresponds to the " + _
"'mySearchResult' search result is : {0}" + _
ControlChars.Newline, myDirectoryEntry.Name)
Dim mySearchResultPath As String = mySearchResult.Path
Console.WriteLine("The path for the 'mySearchResult' search result is : {0}" + _
ControlChars.Newline, mySearchResultPath)
' Get the properties of the 'mySearchResult'.
Dim myResultPropColl As ResultPropertyCollection
myResultPropColl = mySearchResult.Properties
Console.WriteLine("The properties of the 'mySearchResult' are :")
Dim myKey As String
For Each myKey In myResultPropColl.PropertyNames
Dim tab1 As String = " "
Console.WriteLine(myKey + " = ")
Dim myCollection As Object
For Each myCollection In myResultPropColl(myKey)
Console.WriteLine(tab1 + myCollection)
Next myCollection
Next myKey
myDirectoryEntry.Dispose()
mySearchRoot.Dispose()
Else
Console.WriteLine("The '" + myLDAPPath + "' path not found.")
End If
Catch e As Exception
Console.WriteLine("The '" + myLDAPPath + "' path not found.")
Console.WriteLine("Exception : " & e.Message)
End Try
End Sub 'Main
End Class 'MySample
Example Code [C#]
The following example creates a new DirectoryEntry with the search criteria and uses the FindOne method to initiate the search. The search result is stored in GetDirectoryEntry, where the example then retrieve and parse the search result from.
using System;
using System.DirectoryServices;
public class MySample
{
public static void Main()
{
string myLDAPPath = "";
try
{
// Create a 'DirectoryEntry' object to search.
Console.WriteLine("Enter the path ( Ex : 'LDAP://MyServer')");
myLDAPPath = Console.ReadLine();
DirectoryEntry mySearchRoot = new DirectoryEntry(myLDAPPath);
DirectorySearcher myDirectorySearcher =
new DirectorySearcher(mySearchRoot);
// Get the first entry of the search.
SearchResult mySearchResult = myDirectorySearcher.FindOne();
if ( mySearchResult != null )
{
// Get the 'DirectoryEntry' that corresponds to 'mySearchResult'.
DirectoryEntry myDirectoryEntry =
mySearchResult.GetDirectoryEntry();
Console.WriteLine("\nThe name of the 'myDirectoryEntry' " +
"directory entry that corresponds to the " +
"'mySearchResult' search result is : {0}\n",
myDirectoryEntry.Name);
string mySearchResultPath = mySearchResult.Path;
Console.WriteLine("The path for the 'mySearchResult' search "
+ "result is : {0}\n", mySearchResultPath);
// Get the properties of the 'mySearchResult'.
ResultPropertyCollection myResultPropColl;
myResultPropColl = mySearchResult.Properties;
Console.WriteLine("The properties of the " +
"'mySearchResult' are :");
foreach( string myKey in myResultPropColl.PropertyNames)
{
string tab = " ";
Console.WriteLine(myKey + " = ");
foreach( Object myCollection in myResultPropColl[myKey])
{
Console.WriteLine(tab + myCollection);
}
}
mySearchRoot.Dispose();
myDirectoryEntry.Dispose();
}
else
{
Console.WriteLine("The '" + myLDAPPath + "' path not found.");
}
}
catch(Exception e)
{
Console.WriteLine("The '" + myLDAPPath + "' path not found.");
Console.WriteLine("Exception : " + e.Message);
}
}
}
Example Code [Managed C++]
The following example creates a new DirectoryEntry with the search criteria and uses the FindOne method to initiate the search. The search result is stored in GetDirectoryEntry, where the example then retrieve and parse the search result from.
#using <mscorlib.dll>
#using <System.dll>
#using <System.Directoryservices.dll>
using namespace System;
using namespace System::Collections;
using namespace System::DirectoryServices;
int main()
{
String* myLDAPPath = S"";
try
{
// Create a 'DirectoryEntry' object to search.
Console::WriteLine(S"Enter the path ( Ex : 'LDAP://MyServer')");
myLDAPPath = Console::ReadLine();
DirectoryEntry* mySearchRoot = new DirectoryEntry(myLDAPPath);
DirectorySearcher* myDirectorySearcher = new DirectorySearcher(mySearchRoot);
// Get the first entry of the search.
SearchResult* mySearchResult = myDirectorySearcher->FindOne();
if (mySearchResult)
{
// Get the 'DirectoryEntry' that corresponds to 'mySearchResult'.
DirectoryEntry* myDirectoryEntry = mySearchResult->GetDirectoryEntry();
Console::WriteLine(
String::Concat(S"\nThe name of the 'myDirectoryEntry' ",
S"directory entry that corresponds to the ",
S"'mySearchResult' search result is : {0}\n"),
myDirectoryEntry->Name);
String* mySearchResultPath = mySearchResult->Path;
Console::WriteLine(S"The path for the 'mySearchResult' search result is :
{0}\n", mySearchResultPath);
// Get the properties of the 'mySearchResult'.
ResultPropertyCollection* myResultPropColl = mySearchResult->Properties;
Console::WriteLine(S"The properties of the 'mySearchResult' are :");
IEnumerator* myEnum = myResultPropColl->PropertyNames->GetEnumerator();
while (myEnum->MoveNext())
{
String* myKey = __try_cast<String*>(myEnum->Current);
Console::WriteLine(S"{0} = ", myKey);
IEnumerator* myEnum = myResultPropColl->Item[myKey]->GetEnumerator();
while (myEnum->MoveNext())
{
Console::WriteLine(S"\t{0}", myEnum->Current);
}
}
myDirectoryEntry->Dispose();
mySearchRoot->Dispose();
}
else
{
Console::WriteLine(S"The '{0}' path not found.", myLDAPPath);
}
}
catch (Exception* e)
{
Console::WriteLine(S"The '{0}' path not found.", myLDAPPath);
Console::WriteLine(S"Exception : {0}", e->Message);
}
}
Requirements
| Client | Requires Windows XP Home Edition, Windows XP Professional, Windows Me, or Windows 98. |
| Server | Requires Windows Server 2003, Windows 2000, or Windows NT 4.0. |
| Namespace | Defined in System.DirectoryServices. |
| Assembly | Requires System.DirectoryServices (in System.DirectoryServices.dll). |
| .NET Framework | Requires .NET Framework 1.0. |
See Also
System.DirectoryServices Namespace, Managed Extensions for C++ Programming