PFE_IMPORT_FUNC回呼函式 (winbase.h)

發行項
08/27/2023

搭配 WriteEncryptedFileRaw使用的應用程式定義回呼函式。系統每次擷取備份檔案資料的一部分時，都會呼叫 ImportCallback 一或多次。 ImportCallback 會循序從備份檔案讀取資料並還原資料，而且系統會繼續呼叫它，直到讀取所有備份檔案資料為止。

PFE_IMPORT_FUNC類型會定義這個回呼函式的指標。 ImportCallback 是應用程式定義函數名稱的預留位置。

語法

PFE_IMPORT_FUNC PfeImportFunc;

DWORD PfeImportFunc(
  [in]           PBYTE pbData,
  [in, optional] PVOID pvCallbackContext,
  [in, out]      PULONG ulLength
)
{...}

參數

[in] pbData

系統提供的緩衝區指標，將接收要還原的資料區塊。

[in, optional] pvCallbackContext

應用程式定義和已配置之內容區塊的指標。應用程式會將此指標傳遞至 WriteEncryptedFileRaw，並將此指標傳遞至回呼函式，讓回呼函式可以存取應用程式特定的資料。此資料可以是結構，而且可以包含應用程式所需的任何資料，例如包含加密檔案備份複本之檔案的控制碼。

[in, out] ulLength

在函式專案上，此參數會指定系統所提供的緩衝區長度。回呼函式必須寫入 pbData 參數所指向的緩衝區不超過這個數目的位元組。

結束時，函式必須將此設定為寫入 pbData的資料位元組數目。

傳回值

如果函式成功，它必須將傳回值設定為 ERROR_SUCCESS，並將 ulLength 參數所指向的值設定為複製到 pbData的位元組數目。

到達備份檔案結尾時，請將 ulLength 設定為零，告知系統已處理整個檔案。

如果函式失敗，請將傳回值設定為 WinError.h 中定義的非零錯誤碼。例如，如果此函式因為呼叫的 API 失敗而失敗，您可以將傳回值設定為失敗 API 的 GetLastError 所傳回的值。

備註

系統會呼叫 ImportCallback 函式，直到回呼函式指出沒有其他要還原的資料為止。若要指出沒有其他要還原的資料，請將 *ulLength 設定為 0，並使用 ERROR_SUCCESS的傳回碼。您可以使用應用程式定義的內容區塊來內部追蹤資訊，例如檔案控制代碼和檔案中的目前位移。

規格需求


最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限桌面應用程式]
目標平台	Windows
標頭	winbase.h (包含 Windows.h)