cfExecute 函式 (cfapi.h)
所有連線索引鍵型佔位符作業的主要進入點。 同步提供者會使用它來回應來自平台的各種回呼。
語法
HRESULT CfExecute(
[in] const CF_OPERATION_INFO *OpInfo,
[in, out] CF_OPERATION_PARAMETERS *OpParams
);
參數
[in] OpInfo
佔位元上的作業相關信息。
[in, out] OpParams
佔位元上作業的參數。
傳回值
如果函式成功,則會傳 S_OK
回 。 否則,它會傳回 HRESULT 錯誤碼。
備註
對 CfExecute 的有效呼叫會重設屬於相同同步提供者進程之所有擱置回呼要求的定時器。
CfExecute 會採用兩個可變大小的自變數,也就是 CF_OPERATION_INFO 和 CF_OPERATION_PARAMETERS,其中一個識別作業類型,另一個則提供詳細的作業參數。 這兩個自變數都是從對應結構開頭的 StructSize 字段開始。 CfExecute 的呼叫端負責正確計算結構大小。
平臺會將 ConnectionKey、 TransferKey 和 CorrelationVector 提供給向 CfConnectSyncRoot 註冊的所有回呼函式。 此外,同步提供者可以使用 CfGetTransferKey 取得 TransferKey,並使用 CfGetCorrelationVector 取得 CorrelationVector。
或者,同步提供者可以將同步狀態 Blob 提供給平臺。 如果在 CF_OPERATION_INFO 的 SyncStatus 字段中設定非 Null 指標,則會將其內容保留在檔案上,直到移除最後一個句柄為止。 平臺會在雲端檔案佔位元上任何失敗的作業上查詢此資訊。 如果有的話,平臺會使用提供的資訊來建構更有意義的且可採取動作的訊息給使用者。
如果 null 指標是在 CF_OPERATION_INFO 的 SyncStatus 欄位中設定,平臺將會清除先前設定的同步狀態 (如果有) 。
所有作業都可以在同步提供者進程中的任意線程內容中執行。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 10 版本 1709 [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2016 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | cfapi.h |
程式庫 | CldApi.lib |
Dll | CldApi.dll |