IFhConfigMgr::GetIncludeExcludeRules method (fhcfg.h)

Article
10/13/2021

Retrieves the inclusion and exclusion rules that are currently stored in an FhConfigMgr object.

Note

IFhConfigMgr is deprecated and may be altered or unavailable in future releases.

Syntax

HRESULT GetIncludeExcludeRules(
  [in]  BOOL                       Include,
  [in]  FH_PROTECTED_ITEM_CATEGORY Category,
  [out] IFhScopeIterator           **Iterator
);

Parameters

[in] Include

If set to TRUE, inclusion rules are returned. If set to FALSE, exclusion rules are returned.

[in] Category

An FH_PROTECTED_ITEM_CATEGORY enumeration value that specifies the type of the inclusion or exclusion rules.

[out] Iterator

Receives an IFhScopeIterator interface pointer that can be used to enumerate the rules in the requested category.

Return value

S_OK on success, or an unsuccessful HRESULT on failure. Possible unsuccessful HRESULT values include values defined in the FhErrors.h header file.

Remarks

The File History protection scope is the set of files that are backed up by this feature. It contains inclusion rules and exclusion rules. Inclusion rules specify the files and folders that are included. Exclusion rules specify the files and folders that are excluded.

The default protection scope includes all folders from all user libraries and the Contacts, Desktop, and Favorites folders.

You can modify the File History protection scope by adding exclusion rules to reduce the File History protection scope without removing folders from user libraries.

Exclusion rules take precedence over inclusion rules. In other words, if an inclusion rule conflicts with an exclusion rule, the File History feature follows the exclusion rule.

The IFhConfigMgr::AddRemoveExcludeRule method can be used to add or remove exclusion rules. It cannot be used to modify the inclusion rules.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	fhcfg.h