Forest.FindGlobalCatalog Method (String, LocatorOptions)

Finds a global catalog in this forest for a specified site and location criteria.

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

public GlobalCatalog FindGlobalCatalog(
	string siteName,
	LocatorOptions flag
)

Parameters

siteName
Type: System.String

The name of the site to search.

flag
Type: System.DirectoryServices.ActiveDirectory.LocatorOptions

A LocatorOptions value that specifies the location criteria.

Return Value

Type: System.DirectoryServices.ActiveDirectory.GlobalCatalog
A GlobalCatalog object for the specified site and location criteria.

ExceptionCondition
ActiveDirectoryObjectNotFoundException

A global catalog cannot be located.

ActiveDirectoryOperationException

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

ArgumentException

siteName is an empty string.

ArgumentNullException

siteName is null.

ObjectDisposedException

The object has been disposed.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft