AF SDK Reference

AFActiveDirectoryProperties.UseGlobalCatalog Property

Save PDF

TABLE OF CONTENTS

AFActiveDirectoryProperties.UseGlobalCatalog Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Indicates whether to used the cached global catalog or Active Directory to retrieve users.

Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public bool UseGlobalCatalog { get; set; }

Public Property UseGlobalCatalog As Boolean
	Get
	Set

Dim instance As AFActiveDirectoryProperties
Dim value As Boolean

value = instance.UseGlobalCatalog

instance.UseGlobalCatalog = value

public:
property bool UseGlobalCatalog {
	bool get ();
	void set (bool value);
}

member UseGlobalCatalog : bool with get, set

Property Value

Type: Boolean
Returns to indicate the global cache should be searched instead of Active Directory.

Remarks

Active directory caches some information into what is called the global catalog. For installations where there are multiple, distributed domain controllers, each domain controller will have a cache of the global catalog so that searches do not have to be referred to the owning domain controller. This helps with performance on queries that would otherwise have to access a remote domain controller. This setting tells the search whether or not to use the global catalog if it is available or if to force the search to go to the owning domain controller.

AF SDK Reference