Forest.GetForest(DirectoryContext) Method

Definition

Namespace:

System.DirectoryServices.ActiveDirectory

Assembly:

System.DirectoryServices.dll

Package:

System.DirectoryServices v9.0.0-rc.2.24473.5

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.

See also

• DirectoryContext