FH_LOCAL_POLICY_TYPE enumeration

Specifies the type of a local policy for the File History feature. Each local policy has a numeric parameter associated with it.

Syntax


typedef enum _FH_LOCAL_POLICY_TYPE { 
  FH_FREQUENCY       = 0,
  FH_RETENTION_TYPE  = 1,
  FH_RETENTION_AGE   = 2,
  MAX_LOCAL_POLICY   = 3
} FH_LOCAL_POLICY_TYPE;

Constants

FH_FREQUENCY

This local policy specifies how frequently backups are to be performed for the current user. The numeric parameter contains the time, in seconds, from the end of one backup until the start of the next one. The default value of the numeric parameter for this policy is 3600 seconds (1 hour).

FH_RETENTION_TYPE

This local policy specifies when previous versions of files and folders can be deleted from a backup target. See the FH_RETENTION_TYPES enumeration for the list of possible values. The default value of the numeric parameter for this policy is FH_RETENTION_DISABLED.

FH_RETENTION_AGE

This local policy specifies the minimum age of previous versions that can be deleted from a backup target when the FH_RETENTION_AGE_BASED retention type is specified. For more information, see the FH_RETENTION_TYPES enumeration. The numeric parameter contains the minimum age, in days. The default value of the numeric parameter for this policy is 365 days (1 year).

MAX_LOCAL_POLICY

The maximum enumeration value for this enumeration. This value and all values greater than it are reserved for system use.

Remarks

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

To set the value of the numeric parameter for the local policy, use the IFhConfigMgr::SetLocalPolicy method.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Fhcfg.h

IDL

Fhcfg.idl

See also

FH_RETENTION_TYPES
IFhConfigMgr::GetLocalPolicy
IFhConfigMgr::SetLocalPolicy

 

 

Show: