云筛选器 API

云筛选器 API 技术概述。

若要开发云筛选器 API，需要以下标头：

• cfapi.h

有关此技术的编程指南，请参阅：

• 云筛选器 API

枚举

CF_CALLBACK_CANCEL_FLAGS 用于取消占位符文件或文件夹的数据提取的回调标志。
CF_CALLBACK_CLOSE_COMPLETION_FLAGS 用于通知同步提供程序其某个同步根下的占位符的回调标志，该占位符之前已打开进行读/写/删除访问。
CF_CALLBACK_DEHYDRATE_COMPLETION_FLAGS 一个回调标志，用于通知同步提供程序其某个同步根下的占位符已成功解除冻结。
CF_CALLBACK_DEHYDRATE_FLAGS 用于通知同步提供程序其某个同步根下的占位符将解除冻结的回调标志。
CF_CALLBACK_DEHYDRATION_REASON 指定云文件被冻结的原因。
CF_CALLBACK_DELETE_COMPLETION_FLAGS 用于通知同步提供程序已成功删除占位符的回调标志。
CF_CALLBACK_DELETE_FLAGS 此回调用于通知同步提供程序，其某个同步根下的占位符文件或目录即将被删除或取消删除。
CF_CALLBACK_FETCH_DATA_FLAGS 用于提取占位符文件或文件夹数据的回调标志。
CF_CALLBACK_FETCH_PLACEHOLDERS_FLAGS 用于提取有关占位符文件或目录内容的信息的标志。
CF_CALLBACK_OPEN_COMPLETION_FLAGS 用于通知同步提供程序已成功打开占位符进行读/写/删除访问的回调标志。
CF_CALLBACK_RENAME_COMPLETION_FLAGS 一个回调标志，用于通知同步提供程序其某个同步根下的占位符已成功重命名。
CF_CALLBACK_RENAME_FLAGS 回调用标志以通知同步提供程序其同步根之一下的占位符即将重命名或移动。
CF_CALLBACK_TYPE 包含对占位符文件或文件夹使用的各种类型的回调。
CF_CALLBACK_VALIDATE_DATA_FLAGS 用于验证占位符文件或目录的数据的标志。
CF_CONNECT_FLAGS 同步提供程序在调用其回调时可以请求的其他信息。
CF_CONVERT_FLAGS 普通文件/目录到占位符的文件/目录转换标志。
CF_CREATE_FLAGS 用于创建占位符文件或目录的标志。
CF_DEHYDRATE_FLAGS 占位符解除冻结标志。
CF_HARDLINK_POLICY 指定是否允许在占位符文件上使用硬链接。
CF_HYDRATE_FLAGS 占位符数据解除冻结标志。
CF_HYDRATION_POLICY_MODIFIER 允许同步提供程序控制平台应如何冻结占位符文件。 这是可与主策略：_CF_HYDRATION_POLICY_PRIMARY一起使用的修饰符。
CF_HYDRATION_POLICY_PRIMARY 允许同步提供程序控制平台应如何冻结占位符文件。 这是主要策略。
CF_IN_SYNC_STATE 指定占位符文件和文件夹的同步状态。
CF_INSYNC_POLICY 允许同步提供程序控制平台何时应清除占位符文件或目录上的同步状态的策略。
CF_OPEN_FILE_FLAGS 用于请求打开文件时的各种权限的标志。
CF_OPERATION_ACK_DATA_FLAGS 用于验证和确认占位符文件或文件夹的数据的标志。
CF_OPERATION_ACK_DEHYDRATE_FLAGS 用于确认占位符文件或目录的解除冻结的标志。
CF_OPERATION_ACK_DELETE_FLAGS 用于确认删除占位符文件或目录的标志。
CF_OPERATION_ACK_RENAME_FLAGS 用于确认占位符文件或目录重命名的标志。
CF_OPERATION_RESTART_HYDRATION_FLAGS 用于在占位符文件或文件夹上重启数据解除冻结的标志。
CF_OPERATION_RETRIEVE_DATA_FLAGS 用于检索占位符文件或文件夹数据的标志。
CF_OPERATION_TRANSFER_DATA_FLAGS 用于将数据传输到占位符文件或文件夹水合的标志。
CF_OPERATION_TRANSFER_PLACEHOLDERS_FLAGS 用于指定传输占位符文件或目录时的行为的标志。
CF_OPERATION_TYPE 可以对占位符文件和目录执行的操作类型。
CF_PIN_STATE 占位符文件或目录的固定状态。
CF_PLACEHOLDER_CREATE_FLAGS 用于基于每个占位符创建占位符的标志。
CF_PLACEHOLDER_INFO_CLASS 占位符信息的信息类。
CF_PLACEHOLDER_MANAGEMENT_POLICY 指定CF_SYNC_POLICIES结构的占位符管理策略。
CF_PLACEHOLDER_RANGE_INFO_CLASS 占位符文件数据范围的类型。
CF_PLACEHOLDER_STATE 占位符文件或文件夹的状态。
CF_POPULATION_POLICY_MODIFIER 定义填充策略修饰符。 这是可与主策略：_CF_POPULATION_POLICY_PRIMARY一起使用的修饰符。
CF_POPULATION_POLICY_PRIMARY 允许同步提供程序控制平台应如何创建占位符目录和文件。 这是主要策略。
CF_REGISTER_FLAGS 用于注册和更新同步根的标志。
CF_REVERT_FLAGS 用于将占位符文件还原为常规文件的标志。
CF_SET_IN_SYNC_FLAGS 占位符文件和文件夹的同步状态标志。
CF_SET_PIN_FLAGS 占位符固定标志。
CF_SYNC_PROVIDER_STATUS 同步提供程序的当前状态。
CF_SYNC_ROOT_INFO_CLASS 同步根信息的类型。
CF_UPDATE_FLAGS 用于更新占位符文件或目录的标志。

函数

CfCloseHandle 关闭 CfOpenFileWithOplock 返回的文件或目录句柄。 这不应与标准 Win32 文件句柄一起使用，只能在 CfApi.h 中使用的句柄上使用。
CfConnectSyncRoot 启动同步提供程序与同步筛选器 API 之间的双向通信。
CfConvertToPlaceholder 将普通文件/目录转换为占位符文件/目录。
CfCreatePlaceholders 在同步根树下创建一个或多个新的占位符文件或目录。
CfDisconnectSyncRoot 断开 CfConnectSyncRoot 创建的信道的连接。
CfExecute 所有基于连接键的占位符操作的主入口点。 同步提供程序打算使用它来响应来自平台的各种回调。
CfGetCorrelationVector 允许同步提供程序查询给定占位符文件的当前相关向量。
CfGetPlaceholderInfo 获取占位符文件或文件夹的各种特征。
CfGetPlaceholderRangeInfo 获取有关占位符文件或文件夹的范围信息。
CfGetPlaceholderRangeInfoForHydration 使用 ConnectionKey、TransferKey 和 FileId 作为标识符获取有关占位符文件或文件夹的范围信息。
CfGetPlaceholderStateFromAttributeTag 根据文件的 FileAttributes 和 ReparseTag 值获取一组占位符状态。
CfGetPlaceholderStateFromFileInfo 根据文件的各种信息获取一组占位符状态。
CfGetPlaceholderStateFromFindData 获取基于WIN32_FIND_DATA结构的一组占位符状态。
CfGetPlatformInfo 获取平台版本信息。
CfGetSyncRootInfoByHandle 获取包含由文件句柄指定的给定文件的同步根的各种特征。
CfGetSyncRootInfoByPath 获取在同步根目录下给定文件的各种同步根信息。
CfGetTransferKey 启动将数据传输到占位符文件或文件夹中。
CfGetWin32HandleFromProtectedHandle 将受保护的句柄转换为 Win32 句柄，以便它可以与所有基于句柄的 Win32 API 一起使用。
CfHydratePlaceholder 通过确保指定的字节范围出现在占位符的磁盘上来冻结占位符文件。 这仅适用于文件。
CfOpenFileWithOplock 为普通文件和占位符文件) 打开文件或目录 (异步不透明句柄，并基于打开的标志为其设置适当的 oplock。
CfQuerySyncProviderStatus 查询同步提供程序以获取提供程序的状态。
CfReferenceProtectedHandle 允许调用方将受保护的句柄引用到可用于非 CfApi Win32 API 的 Win32 句柄。
CfRegisterSyncRoot 执行一次性同步根注册。
CfReleaseProtectedHandle 释放 CfReferenceProtectedHandle 引用的受保护句柄。
CfReleaseTransferKey 释放 CfGetTransferKey 获取的传输密钥。
CfReportProviderProgress 允许同步提供程序报告带外进度。
CfReportProviderProgress2 允许同步提供程序报告带外进度。 使用其他参数扩展 CfReportProviderProgress。
CfReportSyncStatus 允许同步提供程序在指定同步根上通知平台其状态，而无需先通过调用 CfConnectSyncRoot 进行连接。
CfRevertPlaceholder 将占位符还原回常规文件，去除所有特殊特征，例如重新分析标记、文件标识等。
CfSetCorrelationVector 允许同步提供程序指示平台在占位符文件上使用特定的相关向量进行遥测。 此为可选项。
CfSetInSyncState 设置占位符文件或文件夹的同步状态。
CfSetPinState 这会设置用于表示用户意向的占位符的固定状态。 任何应用程序 (，而不仅仅是同步提供程序) 都可以调用此函数。
CfUnregisterSyncRoot 取消注册以前注册的同步根。
CfUpdatePlaceholder 汇报占位符文件或目录的特征。
CfUpdateSyncProviderStatus 汇报同步提供程序的当前状态。

結構

CF_CALLBACK_INFO 包含常见的回调信息。
CF_CALLBACK_PARAMETERS 包含特定于回调的参数，例如文件偏移量、长度、标志等。
CF_CALLBACK_REGISTRATION 同步提供程序要注册的回调。
CF_FILE_RANGE 指定占位符文件中的数据范围。
CF_FS_METADATA 占位符文件或目录元数据。
CF_HYDRATION_POLICY 指定主要混合策略及其修饰符。
CF_OPERATION_INFO 有关占位符文件或文件夹上的操作的信息。
CF_OPERATION_PARAMETERS 占位符文件或文件夹上的操作的参数。
CF_PLACEHOLDER_BASIC_INFO 基本占位符信息。
CF_PLACEHOLDER_CREATE_INFO 包含用于创建新占位符文件或目录的占位符信息。
CF_PLACEHOLDER_STANDARD_INFO 标准占位符信息。
CF_PLATFORM_INFO 返回云文件平台的信息。 这适用于在多个版本的 Windows 上运行的同步提供程序。
CF_POPULATION_POLICY 指定主要填充策略及其修饰符。
CF_PROCESS_INFO 包含有关用户进程的信息。
CF_SYNC_POLICIES 定义同步根目录使用的同步策略。
CF_SYNC_REGISTRATION 要注册的同步提供程序和同步根的详细信息。
CF_SYNC_ROOT_BASIC_INFO 基本同步根信息。
CF_SYNC_ROOT_PROVIDER_INFO 同步根提供程序信息。
CF_SYNC_ROOT_STANDARD_INFO 标准同步根信息。
CF_SYNC_STATUS 在 CF_OPERATION_INFO 结构中用于描述指定同步根的状态。