Edit

CF_CONVERT_FLAGS enumeration (cfapi.h)

  • Article

Normal file/directory to placeholder file/directory conversion flags.

Syntax

typedef enum CF_CONVERT_FLAGS {
  CF_CONVERT_FLAG_NONE = 0x00000000,
  CF_CONVERT_FLAG_MARK_IN_SYNC = 0x00000001,
  CF_CONVERT_FLAG_DEHYDRATE = 0x00000002,
  CF_CONVERT_FLAG_ENABLE_ON_DEMAND_POPULATION = 0x00000004,
  CF_CONVERT_FLAG_ALWAYS_FULL = 0x00000008,
  CF_CONVERT_FLAG_FORCE_CONVERT_TO_CLOUD_FILE = 0x00000010
} ;

Constants

 
CF_CONVERT_FLAG_NONE
Value: 0x00000000
No conversion flags.
CF_CONVERT_FLAG_MARK_IN_SYNC
Value: 0x00000001
The platform marks the converted placeholder as in sync with cloud upon a successful conversion of the file.
CF_CONVERT_FLAG_DEHYDRATE
Value: 0x00000002
Applicable to files only. When specified, the platform dehydrates the file after converting it to a placeholder successfully. The caller must acquire an exclusive handle when specifying this flag or data corruptions can occur. Note that the platform does not validate the exclusiveness of the handle.
CF_CONVERT_FLAG_ENABLE_ON_DEMAND_POPULATION
Value: 0x00000004
Applicable for directories only. When specified, it marks the converted placeholder directory as partially populated such that any future access to it will result in a FETCH_PLACEHOLDERS callback sent to the sync provider.
CF_CONVERT_FLAG_ALWAYS_FULL
Value: 0x00000008
When this flag is present, the newly created placeholder will be marked as always full. Once hydrated, any attempt to dehydrate such a (file) placeholder will fail with error code ERROR_CLOUD_FILE_DEHYDRATION_DISALLOWED. This flag is enforced on a placeholder file only. It can be set on a placeholder directory, but it has no effect.
CF_CONVERT_FLAG_FORCE_CONVERT_TO_CLOUD_FILE
Value: 0x00000010
When specified, the platform allows a sync engine to atomically convert a non-cloud files placeholder (having another reparse tag/data) to a cloud files placeholder. Note that the API normally fails conversion of any non-placeholder file to a placeholder.

The combination **(CF_CONVERT_FLAG_FORCE_CONVERT_TO_CLOUD_FILE		 CF_CONVERT_FLAG_DEHYDRATE)** is especially useful in migration scenarios when certain providers are migrating from another platform to cloud files platform and they intend to convert hydrated placeholders on the older platform to dehydrated placeholders on the cloud files platform atomically. Just this flag should be passed for converting full placeholders to cloud files placeholders. If the older platform implements full files as a regular, non-placeholder files, this flag is not needed. Passing this flag on a directory converts directories to cloud files as well, though the DEHYDRATE flag doesn’t apply to directories.

Even when the policy CF_PLACEHOLDER_MANAGEMENT_POLICY_CONVERT_TO_UNRESTRICTED was specified with CfRegisterSyncRoot, only processes that have registered/connected to the cloud files sync root are allowed to specify this flag.

>[!NOTE]
>The flag is supported only if the PlatformVersion.IntegrationNumber obtained from CfGetPlatformInfo is 0x500 or higher.

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

CfConvertToPlaceholder

CfRegisterSyncRoot

CfGetPlatformInfo