SearchResult Class

Definition

Namespace:

System.DirectoryServices

Assembly:

System.DirectoryServices.dll

Package:

System.DirectoryServices v9.0.0-rc.2.24473.5

Source:

SearchResult.cs

The SearchResult class encapsulates a node in the Active Directory Domain Services hierarchy that is returned during a search through DirectorySearcher.

public ref class SearchResult

public class SearchResult

type SearchResult = class

Public Class SearchResult

Inheritance

Object

SearchResult

Examples

The following example creates a new DirectoryEntry object with the desired path and uses the FindOne method to initiate the search. After performing the search, the example uses the GetDirectoryEntry method to retrieve the live directory entry identified in the search results.

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  

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);  
        }  
    }  

}  

#using <mscorlib.dll>  
#using <System.dll>  
#using <System.Directoryservices.dll>  

using namespace System;  
using namespace System::Collections;  
using namespace System::DirectoryServices;  
using namespace stdcli::language;  

int main()   
{  
    String^ myLDAPPath = "";  
    try   
    {  
        // Create a 'DirectoryEntry' object to search.  
        Console::WriteLine("Enter the path ( Ex : 'LDAP://MyServer')");  
        myLDAPPath = Console::ReadLine();  
        DirectoryEntry^ mySearchRoot = gcnew DirectoryEntry(myLDAPPath);  

        DirectorySearcher^ myDirectorySearcher = gcnew 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("\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 = mySearchResult->Properties;  
            Console::WriteLine("The properties of the 'mySearchResult' are :");  
            IEnumerator^ myEnum = myResultPropColl->PropertyNames->GetEnumerator();  
            while (myEnum->MoveNext())   
            {  
                String^ myKey = safe_cast<String^>(myEnum->Current);  
                Console::WriteLine("{0} = ", myKey);  
                IEnumerator^ myEnum = myResultPropColl->Item[myKey]->GetEnumerator();  
                while (myEnum->MoveNext())   
                {  
                    Console::WriteLine("\t{0}", myEnum->Current);  
                }  
            }  
            myDirectoryEntry->Dispose();  
            mySearchRoot->Dispose();   
        }   
        else   
        {  
            Console::WriteLine("The '{0}' path not found.", myLDAPPath);  
        }  
    }   
    catch (Exception^ e)   
    {  
        Console::WriteLine("The '{0}' path not found.",  myLDAPPath);  
        Console::WriteLine("Exception : {0}", e->Message);  
    }  
}  

Remarks

Instances of the SearchResult class are very similar to instances of DirectoryEntry class. The crucial difference is that the DirectoryEntry class retrieves its information from the Active Directory Domain Services hierarchy each time a new object is accessed, whereas the data for SearchResult is already available in the SearchResultCollection, where it gets returned from a query that is performed with the DirectorySearcher class. Only those properties that are specified through the DirectorySearcher.PropertiesToLoad collection in your query will be available from SearchResult.

Properties

Path	Gets the path for this SearchResult.
Properties	Gets a ResultPropertyCollection collection of properties for this object.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetDirectoryEntry()	Retrieves the DirectoryEntry that corresponds to the SearchResult from the Active Directory Domain Services hierarchy.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)