Forest.FindGlobalCatalog Method

Definition

Namespace:

System.DirectoryServices.ActiveDirectory

Assembly:

System.DirectoryServices.dll

Finds a single global catalog in this forest.

Overloads

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.

FindGlobalCatalog()

Finds any global catalog in this forest.

public:
 System::DirectoryServices::ActiveDirectory::GlobalCatalog ^ FindGlobalCatalog();

public System.DirectoryServices.ActiveDirectory.GlobalCatalog FindGlobalCatalog ();

member this.FindGlobalCatalog : unit -> System.DirectoryServices.ActiveDirectory.GlobalCatalog

Public Function FindGlobalCatalog () As GlobalCatalog

Returns

GlobalCatalog

A GlobalCatalog of this Forest.

Exceptions

ActiveDirectoryObjectNotFoundException

A global catalog cannot be located.

ActiveDirectoryOperationException

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

ObjectDisposedException

The object has been disposed.

See also

• GlobalCatalog

FindGlobalCatalog(LocatorOptions)

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

public:
 System::DirectoryServices::ActiveDirectory::GlobalCatalog ^ FindGlobalCatalog(System::DirectoryServices::ActiveDirectory::LocatorOptions flag);

public System.DirectoryServices.ActiveDirectory.GlobalCatalog FindGlobalCatalog (System.DirectoryServices.ActiveDirectory.LocatorOptions flag);

member this.FindGlobalCatalog : System.DirectoryServices.ActiveDirectory.LocatorOptions -> System.DirectoryServices.ActiveDirectory.GlobalCatalog

Public Function FindGlobalCatalog (flag As LocatorOptions) As GlobalCatalog

Parameters

flag

LocatorOptions

A LocatorOptions value specifying the location criteria.

Returns

GlobalCatalog

A GlobalCatalog object for the specified location criteria.

Exceptions

ActiveDirectoryObjectNotFoundException

A global catalog cannot be located.

ActiveDirectoryOperationException

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

ObjectDisposedException

The object has been disposed.

See also

• GlobalCatalog
• LocatorOptions

FindGlobalCatalog(String)

Finds a global catalog in this forest for a specified site.

public:
 System::DirectoryServices::ActiveDirectory::GlobalCatalog ^ FindGlobalCatalog(System::String ^ siteName);

public System.DirectoryServices.ActiveDirectory.GlobalCatalog FindGlobalCatalog (string siteName);

member this.FindGlobalCatalog : string -> System.DirectoryServices.ActiveDirectory.GlobalCatalog

Public Function FindGlobalCatalog (siteName As String) As GlobalCatalog

Parameters

siteName

String

The name of the site to search.

Returns

GlobalCatalog

A GlobalCatalog object for the specified site.

Exceptions

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.

See also

• GlobalCatalog

FindGlobalCatalog(String, LocatorOptions)

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

public:
 System::DirectoryServices::ActiveDirectory::GlobalCatalog ^ FindGlobalCatalog(System::String ^ siteName, System::DirectoryServices::ActiveDirectory::LocatorOptions flag);

public System.DirectoryServices.ActiveDirectory.GlobalCatalog FindGlobalCatalog (string siteName, System.DirectoryServices.ActiveDirectory.LocatorOptions flag);

member this.FindGlobalCatalog : string * System.DirectoryServices.ActiveDirectory.LocatorOptions -> System.DirectoryServices.ActiveDirectory.GlobalCatalog

Public Function FindGlobalCatalog (siteName As String, flag As LocatorOptions) As GlobalCatalog

Parameters

siteName

String

The name of the site to search.

flag

LocatorOptions

A LocatorOptions value that specifies the location criteria.

Returns

GlobalCatalog

A GlobalCatalog object for the specified site and location criteria.

Exceptions

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.

See also

• GlobalCatalog
• LocatorOptions