StorageProviderHydrationPolicyModifier Enum

Reference

Definition

Namespace:: Windows.Storage.Provider

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Provides policy modifiers to be used with the primary StorageProviderHydrationPolicy.

This enumeration supports a bitwise combination of its member values.

public enum class StorageProviderHydrationPolicyModifier

/// [System.Flags]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Storage.Provider.CloudFilesContract, 65536)]
enum class StorageProviderHydrationPolicyModifier

[System.Flags]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Storage.Provider.CloudFilesContract), 65536)]
public enum StorageProviderHydrationPolicyModifier

var value = Windows.Storage.Provider.StorageProviderHydrationPolicyModifier.none

Public Enum StorageProviderHydrationPolicyModifier

Inheritance: Enum
StorageProviderHydrationPolicyModifier

Attributes: FlagsAttribute ContractVersionAttribute

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.16299.0)
API contract	Windows.Storage.Provider.CloudFilesContract (introduced in v1.0)

Fields

Name	Value	Description
None	0	No modifiers.
ValidationRequired	1	Once the data is hydrated into the file, it will be validated.
StreamingAllowed	2	This modifier does not allow the platform to store any data on disk returned by a sync provider.
AutoDehydrationAllowed	4	Automatic file dehydration is allowed.
AllowFullRestartHydration	8	This policy modifier grants the platform permission to fully hydrate a file synchronously when it intercepts an attempt by an AV Filter to scan the file. Sync providers that wish to use RestartHydration to change the fileSize from a FetchData Callback must opt-in for the FULL_RESTART_HYDRATION_REQUIRED ALLOW_FULL_RESTART_HYDRATION policy to avoid possible deadlocks with anti-virus and anti-malware software trying to scan the file and the provider trying to change fileSize using RestartHydration.

Remarks

ValidationRequired and StreamingAllowed are mutually exclusive fields.

ValidationRequired offers two guarantees to a sync provider. First, it guarantees that the data returned by the sync provider is always persisted to the disk prior to it being returned to the user application; second, it allows the sync provider to retrieve the same data it has returned previously to the platform and validate its integrity. Only upon a successful confirmation of the integrity by the sync provider will the platform complete the user IO request. This modifier helps support end-to-end data integrity at the cost of extra disk IOs.

StreamingAllowed grants the platform the permission to not store any data returned by a sync provider on local disks. This policy modifier is mutually exclusive with ValidationRequired. The API fails with ERROR_INVALID_PARAMETER when both flags are specified.

AutoDehydrationAllowed grants the platform the permission to dehydrate in-sync cloud file placeholders without the help of sync providers. Without this flag, the platform is not allowed to call CfDehydratePlaceholder directly. Instead, the only supported way to dehydrate a cloud file placeholder is to clear the file’s pinned attribute and set the file’s unpinned attribute and then the actual dehydration will be performed asynchronously by the sync engine after it receives the directory change notification on the two attributes. When this flag is specified, the platform will be allowed to invoke CfDehydratePlaceholder directly on any in-sync cloud file placeholder. It is recommended for sync providers to support auto dehydration.

Version history

Windows version	SDK version	Value added
1809	17763	AutoDehydrationAllowed

Applies to

Share via