Edit

Forest.GetForest(DirectoryContext) Method

  • Reference

Definition

Namespace:
System.DirectoryServices.ActiveDirectory
Assembly:
System.DirectoryServices.dll
Package:
System.DirectoryServices v6.0.0
Package:
System.DirectoryServices v7.0.0
Package:
System.DirectoryServices v8.0.0
Package:
System.DirectoryServices v9.0.0-preview.3.24172.9
Source:
Forest.cs
Source:
Forest.cs
Source:
Forest.cs
Source:
Forest.cs

Gets a Forest object for the specified context.

public:
 static System::DirectoryServices::ActiveDirectory::Forest ^ GetForest(System::DirectoryServices::ActiveDirectory::DirectoryContext ^ context);
public static System.DirectoryServices.ActiveDirectory.Forest GetForest (System.DirectoryServices.ActiveDirectory.DirectoryContext context);
static member GetForest : System.DirectoryServices.ActiveDirectory.DirectoryContext -> System.DirectoryServices.ActiveDirectory.Forest
Public Shared Function GetForest (context As DirectoryContext) As Forest

Parameters

context
DirectoryContext

A DirectoryContext object that contains the target and credentials to use to retrieve the object.

Returns

Forest

A Forest object that represents the forest that was retrieved by this method.

Exceptions

ActiveDirectoryObjectNotFoundException

A connection to the target that is specified in context could not be made.

ActiveDirectoryOperationException

A call to the underlying directory service resulted in an error.

ArgumentException

context is not valid.

ArgumentNullException

context is null.

Applies to

See also