cfHydratePlaceholder 函式 (cfapi.h)

確保指定的位元組範圍出現在佔位元中的磁碟上，以凍結佔位符檔案。 這隻適用於檔案。

語法

HRESULT CfHydratePlaceholder(
  [in]                HANDLE           FileHandle,
  [in]                LARGE_INTEGER    StartingOffset,
  [in]                LARGE_INTEGER    Length,
  [in]                CF_HYDRATE_FLAGS HydrateFlags,
  [in, out, optional] LPOVERLAPPED     Overlapped
);

參數

[in] FileHandle

要凍結之佔位符檔案的句柄。 屬性或無存取句柄已足夠。

[in] StartingOffset

佔位元檔案數據的起點位移。

[in] Length

佔位元檔案的長度，以位元組為單位，其數據必須在 API 成功完成之後，於本機磁碟上取得。 定義為 -1) 表示檔案結尾的 (長度 CF_EOF 。 對於不存在於佔位元中的任何子範圍，平臺會從同步提供者擷取數據，並將其儲存在佔位元的磁碟上。

[in] HydrateFlags

佔位元凍結旗標。 HydrateFlags 必須設定為 CF_HYDRATE_FLAG_NONE。

[in, out, optional] Overlapped

當指定並結合異步 FileHandle 時， 重疊 可讓平臺以異步方式執行 CfHydratePlaceholder 呼叫。 如需詳細資訊 ，請參閱 。

如果未指定，不論句柄的建立方式為何，平臺都會同步執行 API 呼叫。

傳回值

如果函式成功，則會傳 S_OK回 。 否則，它會傳回 HRESULT 錯誤碼。

備註

呼叫端必須具有 READ_DATA 或 WRITE_DAC 佔位符的存取權，才能凍結。

如果 API 以異步方式使用重疊時傳回HRESULT_FROM_WIN32 (ERROR_IO_PENDING) ，則呼叫端可以使用 GetOverlappedResult 等候。

規格需求

另請參閱

GetOverlappedResult