Skip to content

Commit 3d8c0b4

Browse files
committed
Merged PR 20698: Add hydration policy not supported warning
Add hydration policy 'not supported' warning for `CF_HYDRATION_POLICY_PARTIAL`.
2 parents 663946b + 15e120f commit 3d8c0b4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

sdk-api-src/content/cfapi/ne-cfapi-cf_hydration_policy_primary.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ helpviewer_keywords: ["CF_HYDRATION_POLICY_ALWAYS_FULL","CF_HYDRATION_POLICY_FUL
66
old-location: cloudapi\cf_hydration_policy_primary.htm
77
tech.root: cloudapi
88
ms.assetid: 47ACA107-80AA-42B3-B583-399323E2B11C
9-
ms.date: 03/29/2023
9+
ms.date: 08/24/2023
1010
ms.keywords: CF_HYDRATION_POLICY_ALWAYS_FULL, CF_HYDRATION_POLICY_FULL, CF_HYDRATION_POLICY_PARTIAL, CF_HYDRATION_POLICY_PRIMARY, CF_HYDRATION_POLICY_PRIMARY enumeration, CF_HYDRATION_POLICY_PROGRESSIVE, cfapi/CF_HYDRATION_POLICY_ALWAYS_FULL, cfapi/CF_HYDRATION_POLICY_FULL, cfapi/CF_HYDRATION_POLICY_PARTIAL, cfapi/CF_HYDRATION_POLICY_PRIMARY, cfapi/CF_HYDRATION_POLICY_PROGRESSIVE, cloudApi.cf_hydration_policy_primary
1111
req.header: cfapi.h
1212
req.include-header:
@@ -51,6 +51,9 @@ api_name:
5151

5252
Allows a sync provider to control how placeholder files should be hydrated by the platform. This is the primary policy.
5353

54+
> [!WARNING]
55+
> **CF_HYDRATION_POLICY_PARTIAL** policy is not currently supported.
56+
5457
## -enum-fields
5558

5659
### -field CF_HYDRATION_POLICY_PARTIAL:0
@@ -59,10 +62,7 @@ The same behavior as **CF_HYDRATION_POLICY_PROGRESSIVE**, except that **CF_HYDRA
5962

6063
### -field CF_HYDRATION_POLICY_PROGRESSIVE:1
6164

62-
When **CF_HYDRATION_POLICY_PROGRESSIVE** is selected, the platform will allow a placeholder to be dehydrated. When the platform detects access to a dehydrated placeholder, it will complete the user IO request as soon as it determines that sufficient data is received from the sync provider. However, the platform will continue requesting the remaining content in the placeholder from the sync provider in the background until either the full content of the placeholder is available locally, or the last user handle on the placeholder is closed.
63-
64-
>[!NOTE]
65-
>Sync providers who opt in for **CF_HYDRATION_POLICY_PROGRESSIVE** may not assume that hydration callbacks arrive sequentially from offset 0. In other words, sync providers with **CF_HYDRATION_POLICY_PROGRESSIVE** policy are expected to handle random seeks on the placeholder.
65+
When **CF_HYDRATION_POLICY_PROGRESSIVE** is selected, the platform will allow a placeholder to be dehydrated. When the platform detects access to a dehydrated placeholder, it will complete the user IO request as soon as it determines that sufficient data is received from the sync provider. However, the platform will continue requesting the remaining content in the placeholder from the sync provider in the background until either the full content of the placeholder is available locally, or the last user handle on the placeholder is closed. <br><br>**NOTE**<br>Sync providers who opt in for **CF_HYDRATION_POLICY_PROGRESSIVE** may not assume that hydration callbacks arrive sequentially from offset 0. In other words, sync providers with **CF_HYDRATION_POLICY_PROGRESSIVE** policy are expected to handle random seeks on the placeholder.
6666

6767
### -field CF_HYDRATION_POLICY_FULL:2
6868

0 commit comments

Comments
 (0)