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 錯誤碼。

規格需求

另請參閱

CF_IN_SYNC_STATE

CF_SET_IN_SYNC_FLAGS