Forest.GetForest(DirectoryContext) Method

Reference

Definition

Namespace:: System.DirectoryServices.ActiveDirectory

Assembly:: System.DirectoryServices.dll

Package:: System.DirectoryServices v10.0.0-preview.1.25080.5

Source:: Forest.cs

Source:: Forest.cs

Source:: Forest.cs

Source:: Forest.cs

Source:: Forest.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Product	Versions
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0 (package-provided)
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via