CfSetInSyncState 函数 (cfapi.h)
设置占位符文件或文件夹的同步状态。
语法
HRESULT CfSetInSyncState(
[in] HANDLE FileHandle,
[in] CF_IN_SYNC_STATE InSyncState,
[in] CF_SET_IN_SYNC_FLAGS InSyncFlags,
[in, out, optional] USN *InSyncUsn
);
参数
[in] FileHandle
占位符的句柄。 平台正确地将操作与其他活动请求同步。 属性或无访问句柄就足够了。 调用方必须具有 WRITE_DATA 或 WRITE_DAC 占位符的访问权限。
[in] InSyncState
同步状态。 InSyncState 可以设置为以下值之一：
- 如果指定 了CF_IN_SYNC_STATE_NOT_IN_SYNC ，则当 API 调用成功返回时，平台会清除占位符的同步状态。
- 如果指定 了CF_IN_SYNC_STATE_IN_SYNC ，则平台会在 API 调用成功返回时设置占位符的同步状态。
[in] InSyncFlags
同步状态标志。 有关详细信息 ，请参阅CF_SET_IN_SYNC_FLAGS 。
[in, out, optional] InSyncUsn
指定时，在输入时， InSyncUsn 指示平台仅当文件仍具有与传入的相同 USN 值时执行同步设置。 这是为了结束同步提供程序刚刚同步的占位符更改到云的争用，但在调用 CfSetInSyncState 之前，占位符以某种方式更改。 将指针传递到输入上的 USN 值 0 与传递 NULL 指针相同。 返回时， InSYncUsn 在设置同步状态后收到最终的 USN 值。
返回值
如果此函数成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。
要求
| 要求 | 值 |
|---|---|
| 最低受支持的客户端 | Windows 10版本 1709 [仅限桌面应用] |
| 最低受支持的服务器 | Windows Server 2016 [仅限桌面应用] |
| 目标平台 | Windows |
| 标头 | cfapi.h |
| Library | CldApi.lib |
| DLL | CldApi.dll |