Forest.GetForest Method

Gets a Forest object for the specified context.

Namespace:  System.DirectoryServices.ActiveDirectory
Assembly:  System.DirectoryServices (in System.DirectoryServices.dll)

public static Forest GetForest(
	DirectoryContext context
)

Parameters

context
Type: System.DirectoryServices.ActiveDirectory.DirectoryContext

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

Return Value

Type: System.DirectoryServices.ActiveDirectory.Forest
A Forest object that represents the forest that was retrieved by this method.

ExceptionCondition
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.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft