雲端篩選 API

發行項
03/09/2023

雲端篩選 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 允許呼叫端參考受保護的控制碼至 Win32 控制碼，此控制碼可以搭配非 CfApi WIN32 API 使用。
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結構，以描述指定之同步根目錄的狀態。

共用方式為

雲端篩選 API

列舉

函式

結構

意見反應

其他資源