API Reference
Class
AdmxCatalogService
Builds an AdmxCatalog by scanning ADMX/ADML repositories (Central Store or local paths). Provides two entry points: auto-discovery via domain context and manual directory-based builds.
Inheritance
- Object
- AdmxCatalogService
Methods
public static AdmxCatalog Build(IEnumerable<String> directories, String primaryLanguage = null, Boolean includePolicies = true, Nullable<Int32> parallelism = null, Boolean includeHash = true, Boolean includeXmlMeta = true, Boolean includeLanguages = true, Nullable<CancellationToken> cancel = null, Boolean detailed = false, PolicyDetail policyDetail = Basic) #Returns:
AdmxCatalogBuilds a catalog by scanning one or more specified directories for ADMX/ADML files.
Parameters
- directories System.Collections.Generic.IEnumerable{System.String}
- One or more directories containing ADMX files (language subfolders expected beneath each path).
- primaryLanguage System.String = null
- Primary language (e.g., en-US) used to resolve display strings; null to use environment default.
- includePolicies System.Boolean = true
- When true, projects policy definitions into the catalog.
- parallelism System.Nullable{System.Int32} = null
- Maximum concurrent file scans; null chooses a sensible default based on environment.
- includeHash System.Boolean = true
- When true, computes SHA-256 for ADMX and ADML files.
- includeXmlMeta System.Boolean = true
- When true, reads revision and schema version from ADMX.
- includeLanguages System.Boolean = true
- When true, enumerates available languages and optional ADML hashes.
- cancel System.Nullable{System.Threading.CancellationToken} = null
- Optional cancellation token to abort long scans.
- detailed System.Boolean = false
- When true, emits more verbose progress information to logging.
- policyDetail ADPlayground.Gpo.GpoLocal.AdmxCatalogService.PolicyDetail = Basic
- Controls per-policy detail (None/Basic/Full).
Returns
Populated AdmxCatalog for the specified directories.
public static AdmxCatalog BuildAuto(String domainName, String primaryLanguage = null, Boolean includePolicies = true, Nullable<Int32> parallelism = null, Boolean includeHash = true, Boolean includeXmlMeta = true, Boolean includeLanguages = true, Nullable<CancellationToken> cancel = null, Boolean detailed = false, PolicyDetail policyDetail = Basic) #Returns:
AdmxCatalogBuilds a catalog by auto-locating ADMX/ADML directories from Central Store or local policy paths.
Parameters
- domainName System.String
- Optional AD domain to prefer a Central Store (SYSVOL) for discovery; null to use local policy paths.
- primaryLanguage System.String = null
- Primary language (e.g., en-US) used to resolve display strings; null to use environment default.
- includePolicies System.Boolean = true
- When true, projects policy definitions into the catalog.
- parallelism System.Nullable{System.Int32} = null
- Maximum concurrent file scans; null chooses a sensible default based on environment.
- includeHash System.Boolean = true
- When true, computes SHA-256 for ADMX and ADML files.
- includeXmlMeta System.Boolean = true
- When true, reads revision and schema version from ADMX.
- includeLanguages System.Boolean = true
- When true, enumerates available languages and optional ADML hashes.
- cancel System.Nullable{System.Threading.CancellationToken} = null
- Optional cancellation token to abort long scans.
- detailed System.Boolean = false
- When true, emits more verbose progress information to logging.
- policyDetail ADPlayground.Gpo.GpoLocal.AdmxCatalogService.PolicyDetail = Basic
- Controls per-policy detail (None/Basic/Full).
Returns
Populated AdmxCatalog for the discovered repository.