Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SearchResult Class

Encapsulates a node in the Active Directory hierarchy that is returned during a search through DirectorySearcher.

For a list of all members of this type, see SearchResult Members.

System.Object
   System.DirectoryServices.SearchResult

[Visual Basic]
Public Class SearchResult
[C#]
public class SearchResult
[C++]
public __gc class SearchResult
[JScript]
public class 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.

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.

Example

[Visual Basic, C#, 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.

[Visual Basic] 
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
         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

[C#] 
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);
               }
            }
         }
         else
         {
            Console.WriteLine("The '" + myLDAPPath + "' path not found.");
         }
      }
      catch(Exception e)
      {
         Console.WriteLine("The '" + myLDAPPath + "' path not found.");
         Console.WriteLine("Exception : " + e.Message);
      }
   }
}

[C++] 
#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);
                }
            }
        } 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);
    }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.DirectoryServices

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Assembly: System.Directoryservices (in System.Directoryservices.dll)

See Also

SearchResult Members | System.DirectoryServices Namespace | DirectoryEntry | DirectoryEntries | PropertyCollection | PropertyValueCollection | DirectorySearcher | ReferralChasingOption | SearchResultCollection | ResultPropertyCollection | ResultPropertyValueCollection | SearchScope | SortDirection | SortOption

Show:
© 2014 Microsoft