Forest Class

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

The Forest class represents an Active Directory Domain Services forest.

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

Inheritance Hierarchy

System.Object
System.DirectoryServices.ActiveDirectory.Forest

Syntax

C++

[DirectoryServicesPermissionAttribute(SecurityAction.LinkDemand, 
	Unrestricted = true)]
public class Forest : IDisposable

Properties

	Name	Description
	ApplicationPartitions	Gets a collection of all application partitions in the forest.
	Domains	Gets a collection of all domains in the forest.
	ForestMode	Gets the operating mode of the forest.
	ForestModeLevel	Gets the operating mode level of the forest.
	GlobalCatalogs	Gets a collection of all global catalogs in the forest.
	Name	Gets the name of the forest.
	NamingRoleOwner	Gets the domain controller that holds the FSMO naming master role for the forest.
	RootDomain	Gets the first domain that was created in a forest.
	Schema	Gets the schema of the forest.
	SchemaRoleOwner	Gets the domain controller that holds the FSMO schema master role for the forest.
	Sites	Gets a collection of sites that are contained in the forest.

Methods

	Name	Description
	CreateLocalSideOfTrustRelationship(String, TrustDirection, String)	Creates the local side of a trust relationship with the specified forest.
	CreateTrustRelationship(Forest, TrustDirection)	Creates both sides of a trust relationship with the specified forest.
	DeleteLocalSideOfTrustRelationship(String)	Deletes the local side of a trust relationship.
	DeleteTrustRelationship(Forest)	Deletes both sides of a trust relationship.
	Dispose()	Releases all managed and unmanaged resources that are held by the object.
	Dispose(Boolean)	Releases the managed resources that are used by the object and, optionally, releases unmanaged resources.
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	FindAllDiscoverableGlobalCatalogs()	Finds all of the discoverable global catalogs in this forest.
	FindAllDiscoverableGlobalCatalogs(String)	Finds all of the discoverable global catalogs in this forest in a specified site.
	FindAllGlobalCatalogs()	Finds all the global catalogs in this forest.
	FindAllGlobalCatalogs(String)	Finds all the global catalogs in this forest for a given site.
	FindGlobalCatalog()	Finds any global catalog in this forest.
	FindGlobalCatalog(LocatorOptions)	Finds a global catalog in this forest for a specified location criteria.
	FindGlobalCatalog(String)	Finds a global catalog in this forest for a specified site.
	FindGlobalCatalog(String, LocatorOptions)	Finds a global catalog in this forest for a specified site and location criteria.
	GetAllTrustRelationships()	Gets a collection of the trust relationships of the current forest.
	GetCurrentForest()	Gets a Forest object for the current user context.
	GetForest(DirectoryContext)	Gets a Forest object for the specified context.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetSelectiveAuthenticationStatus(String)	Gets a Boolean value that indicates whether selective authentication is enabled on the inbound trust relationship with the specified forest. true if selective authentication is enabled; otherwise, false. For more information, see the Remarks section.
	GetSidFilteringStatus(String)	Gets the SID filtering status of a trust.
	GetTrustRelationship(String)	Gets the trust relationship between this forest and the specified forest.
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	RaiseForestFunctionality(ForestMode)	Raises the mode of operation for the forest.
	RaiseForestFunctionalityLevel(Int32)	Raises the forest functionality level to the given setting.
	RepairTrustRelationship(Forest)	Repairs a trust relationship.
	SetSelectiveAuthenticationStatus(String, Boolean)	Enables or disables selective authentication for an inbound trust.
	SetSidFilteringStatus(String, Boolean)	Sets the SID filtering state with the specified forest.
	ToString()	Returns a string representation of the current forest.(Overrides Object.ToString().)
	UpdateLocalSideOfTrustRelationship(String, String)	Updates the password for the local side of a trust relationship.
	UpdateLocalSideOfTrustRelationship(String, TrustDirection, String)	Updates the password and trust direction for the local side of a trust relationship.
	UpdateTrustRelationship(Forest, TrustDirection)	Updates the trust direction for a trust relationship. The trust directions are updated on both sides of the trust.
	VerifyOutboundTrustRelationship(String)	Verifies that a previously established outbound trust with the specified forest is valid.
	VerifyTrustRelationship(Forest, TrustDirection)	Verifies that a previously established trust with the specified forest is valid.

Security

DirectoryServicesPermission

Demand value: LinkDemand

Version Information

.NET Framework
Available since 2.0

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.