Skip to content

Latest commit

 

History

History
107 lines (73 loc) · 4.54 KB

nf-fhcfg-ifhconfigmgr-getincludeexcluderules.md

File metadata and controls

107 lines (73 loc) · 4.54 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:fhcfg.IFhConfigMgr.GetIncludeExcludeRules
IFhConfigMgr::GetIncludeExcludeRules (fhcfg.h)
Retrieves the inclusion and exclusion rules that are currently stored in an FhConfigMgr object.
FhConfigMgr class [Windows API]
GetIncludeExcludeRules method
GetIncludeExcludeRules
GetIncludeExcludeRules method [Windows API]
GetIncludeExcludeRules method [Windows API]
FhConfigMgr class
GetIncludeExcludeRules method [Windows API]
IFhConfigMgr interface
IFhConfigMgr interface [Windows API]
GetIncludeExcludeRules method
IFhConfigMgr.GetIncludeExcludeRules
IFhConfigMgr::GetIncludeExcludeRules
fhcfg/IFhConfigMgr::GetIncludeExcludeRules
winprog.ifhconfigmgr_getincludeexcluderules
winprog\ifhconfigmgr_getincludeexcluderules.htm
winprog
DE137C08-923D-4ADC-8EBC-2F277F72CAE4
12/05/2018
FhConfigMgr class [Windows API],GetIncludeExcludeRules method, GetIncludeExcludeRules, GetIncludeExcludeRules method [Windows API], GetIncludeExcludeRules method [Windows API],FhConfigMgr class, GetIncludeExcludeRules method [Windows API],IFhConfigMgr interface, IFhConfigMgr interface [Windows API],GetIncludeExcludeRules method, IFhConfigMgr.GetIncludeExcludeRules, IFhConfigMgr::GetIncludeExcludeRules, fhcfg/IFhConfigMgr::GetIncludeExcludeRules, winprog.ifhconfigmgr_getincludeexcluderules
fhcfg.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
Fhcfg.idl
Windows
19H1
IFhConfigMgr::GetIncludeExcludeRules
fhcfg/IFhConfigMgr::GetIncludeExcludeRules
c++
APIRef
kbSyntax
COM
Fhcfg.h
IFhConfigMgr.GetIncludeExcludeRules
FhConfigMgr.GetIncludeExcludeRules

IFhConfigMgr::GetIncludeExcludeRules

-description

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.

-parameters

-param Include [in]

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

-param Category [in]

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

-param Iterator [out]

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

-returns

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.

-see-also

FH_PROTECTED_ITEM_CATEGORY

FhConfigMgr

IFhConfigMgr

IFhConfigMgr::AddRemoveExcludeRule

IFhScopeIterator