Forest.FindGlobalCatalog Method
Definition
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.
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()
- Source:
- Forest.cs
- Source:
- Forest.cs
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
A GlobalCatalog of this Forest.
Exceptions
A global catalog cannot be located.
A call to the underlying directory service resulted in an error.
The object has been disposed.
See also
Applies to
FindGlobalCatalog(LocatorOptions)
- Source:
- Forest.cs
- Source:
- Forest.cs
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
A GlobalCatalog object for the specified location criteria.
Exceptions
A global catalog cannot be located.
A call to the underlying directory service resulted in an error.
The object has been disposed.
See also
Applies to
FindGlobalCatalog(String)
- Source:
- Forest.cs
- Source:
- Forest.cs
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
A GlobalCatalog object for the specified site.
Exceptions
A global catalog cannot be located.
A call to the underlying directory service resulted in an error.
siteName
is an empty string.
siteName
is null
.
The object has been disposed.
See also
Applies to
FindGlobalCatalog(String, LocatorOptions)
- Source:
- Forest.cs
- Source:
- Forest.cs
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
A GlobalCatalog object for the specified site and location criteria.
Exceptions
A global catalog cannot be located.
A call to the underlying directory service resulted in an error.
siteName
is an empty string.
siteName
is null
.
The object has been disposed.