IFhConfigMgr::SetLocalPolicy method (fhcfg.h)

Article
02/22/2024

Changes the numeric parameter value of a local policy in an FhConfigMgr object.

Note

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

Syntax

HRESULT SetLocalPolicy(
  [in] FH_LOCAL_POLICY_TYPE LocalPolicyType,
  [in] ULONGLONG            PolicyValue
);

Parameters

[in] LocalPolicyType

Specifies the local policy.

[in] PolicyValue

Specifies the new value of the numeric parameter for the specified local policy.

Return value

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

Remarks

Each local policy contains a numeric parameter that specifies how or when the File History feature backs up files and folders. See the FH_LOCAL_POLICY_TYPE enumeration for more information about the local policies that can be specified.

To retrieve the numeric parameter value for a local policy, use the IFhConfigMgr::GetLocalPolicy method.

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