Edit

Share via

CF_REGISTER_FLAGS enumeration (cfapi.h)

  • Article

Flags for registering and updating a sync root.

Syntax

typedef enum CF_REGISTER_FLAGS {
  CF_REGISTER_FLAG_NONE = 0x00000000,
  CF_REGISTER_FLAG_UPDATE = 0x00000001,
  CF_REGISTER_FLAG_DISABLE_ON_DEMAND_POPULATION_ON_ROOT = 0x00000002,
  CF_REGISTER_FLAG_MARK_IN_SYNC_ON_ROOT = 0x00000004
} ;

Constants

 
CF_REGISTER_FLAG_NONE
Value: 0x00000000
No registration flags.
CF_REGISTER_FLAG_UPDATE
Value: 0x00000001
Use this flag for modifying previously registered sync root identities and policies.
CF_REGISTER_FLAG_DISABLE_ON_DEMAND_POPULATION_ON_ROOT
Value: 0x00000002
The on-demand directory/folder population behavior is globally controlled by the population policy. This flag allows a sync provider to opt out of the on-demand population behavior just for the sync root itself while keeping on-demand population on for all other directories under the sync root. This is useful when the sync provider would like to pre-populate the immediate child files/directories of the sync root.
CF_REGISTER_FLAG_MARK_IN_SYNC_ON_ROOT
Value: 0x00000004
This flag allows a sync provider to mark the sync root to be registered in-sync simultaneously at the registration time. An alternative is to call CfSetInSyncState on the sync root later.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1709 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Header cfapi.h

See also

CfSetInSyncState

CfRegisterSyncRoot