CFAPI.h 標頭

此標頭被 Cloud Filter API 使用。 如需詳細資訊，請參閱：

• 雲端過濾 API

CFAPI.h 包含以下程式介面：

Functions

CfCloseHandle 關閉 CfOpenFileWithOplock 回傳的檔案或目錄帳號。 此功能不應用於標準 Win32 檔案的句柄，僅適用於 CfApi.h 內使用的句柄。
CfConnectSyncRoot 啟動同步提供者與同步過濾 API 之間的雙向通訊。
CfConvertToPlaceholder 將一般檔案/目錄轉換成佔位檔案/目錄。
CfCreatePlaceholders 在同步根樹下建立一個或多個新的佔位檔或目錄。
CfDisconnectSyncRoot 斷開由 CfConnectSyncRoot 建立的通訊通道。
Cf執行 所有基於連線金鑰的佔位符操作的主要入口。 它旨在由同步提供者用來回應平台的各種回撥。
CfGetCorrelationVector 允許同步提供者查詢給定佔位檔案的當前相關向量。
CfGetPlaceholderInfo 取得佔位檔案或資料夾的各種特性。
CfGet預留位置範圍資訊 取得預留位置檔案或資料夾的範圍資訊。
CfGetPlaceholderRangeInfoForHydration 使用 ConnectionKey、TransferKey 和 FileId 作為識別碼來取得預留位置檔案或資料夾的範圍資訊。
CfGetPlaceholderStateFromAttributeTag 根據檔案的 FileAttributes 和 ReparseTag 值，取得一組佔位狀態。
CfGetPlaceholderStateFromFileInfo 根據檔案中的各種資訊，取得一組佔位狀態。
CfGetPlaceholderStateFromFindData 根據WIN32_FIND_DATA結構獲得一組佔位狀態。
CfGet平台資訊 取得平台版本資訊。
CfGetSyncRootInfoByHandle 取得包含特定檔案的同步根的各種特性，該檔案由檔案句柄指定。
CfGetSyncRootInfoByPath 根據同步根取得各種同步根資訊，並附有檔案。
CfGetTransferKey 啟動資料傳輸到佔位檔案或資料夾。
CfGetWin32HandleFromProtectedHandle 將受保護的句柄轉換為 Win32 句柄，使其能與所有基於句柄的 Win32 API 共用。
CfHydratePlaceholder 透過確保指定的位元組範圍存在於磁碟中，來使佔位檔案產生水合。 此規定僅適用於檔案。
CfOpenFileWithOplock 開啟一個非同步不透明的檔位或目錄（適用於一般與占位檔），並根據開啟的旗標對其設置適當的操作鎖定。
CfQuerySyncProviderStatus 查詢同步提供者以取得該提供者的狀態。
CfReferenceProtectedHandle 允許呼叫者將受保護的句柄參考到 Win32 的 handle ，該 handle 可用於非 CfApi 的 Win32 API。
CfRegisterSyncRoot 執行一次性同步根註冊。
CfReleaseProtectedHandle 釋放由 CfReferenceProtectedHandle 參考的受保護帳號。
CfReleaseTransferKey 釋放由 CfGetTransferKey 取得的傳輸金鑰。
CfReportProvider進度 允許同步處理提供者報告頻外進度。
Cf報告提供者進展2 允許同步處理提供者報告頻外進度。 使用其他參數擴充 CfReportProviderProgress。
CfReport同步狀態 允許同步提供者在不先呼叫 CfConnectSyncRoot 的情況下，通知平台其在指定同步根的狀態。
CfRevertPlaceholder 將佔位符還原為一般檔案，移除所有特殊特性，如 reparse 標籤、檔案識別碼等。
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結構中描述指定同步根節點的狀態。

列舉項目

CF_CALLBACK_CANCEL_FLAGS 回調旗標用於取消佔位檔案或資料夾的資料擷取。
CF_CALLBACK_CLOSE_COMPLETION_FLAGS 回調標誌用於通知同步提供者，該佔位符在其同步根節點下先前已開啟用於讀寫/刪除存取，現在已關閉。
CF_CALLBACK_DEHYDRATE_COMPLETION_FLAGS 一個回調標誌，用來通知同步提供者其 sync 根節點下的佔位符已被成功脫水。
CF_CALLBACK_DEHYDRATE_FLAGS 回調旗標用來通知同步提供者，該位置的某個 sync 根名下的佔位符將會被脫水。
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 用於更新佔位檔或目錄的旗標。