PFE_IMPORT_FUNC fungsi panggilan balik (winbase.h)

Artikel
08/27/2023

Fungsi panggilan balik yang ditentukan aplikasi yang digunakan dengan WriteEncryptedFileRaw. Sistem memanggil ImportCallback satu atau beberapa kali, setiap kali untuk mengambil sebagian data file cadangan. ImportCallback membaca data dari file cadangan secara berurutan dan memulihkan data, dan sistem terus memanggilnya sampai membaca semua data file cadangan.

Jenis PFE_IMPORT_FUNC menentukan penunjuk ke fungsi panggilan balik ini. ImportCallback adalah tempat penampung untuk nama fungsi yang ditentukan aplikasi.

Sintaks

PFE_IMPORT_FUNC PfeImportFunc;

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

Parameter

[in] pbData

Penunjuk ke buffer yang disediakan sistem yang akan menerima blok data yang akan dipulihkan.

[in, optional] pvCallbackContext

Penunjuk ke blok konteks yang ditentukan aplikasi dan dialokasikan. Aplikasi meneruskan penunjuk ini ke WriteEncryptedFileRaw, dan meneruskan penunjuk ini ke fungsi panggilan balik sehingga fungsi panggilan balik dapat memiliki akses ke data khusus aplikasi. Data ini dapat menjadi struktur dan dapat berisi data apa pun yang dibutuhkan aplikasi, seperti handel ke file yang berisi salinan cadangan file terenkripsi.

[in, out] ulLength

Pada entri fungsi, parameter ini menentukan panjang buffer yang disediakan sistem. Fungsi panggilan balik harus menulis tidak lebih dari banyak byte ini ke buffer yang ditujukkan oleh parameter pbData .

Saat keluar, fungsi harus mengatur ini ke jumlah byte data yang ditulis ke dalam pbData.

Mengembalikan nilai

Jika fungsi berhasil, fungsi harus mengatur nilai pengembalian ke ERROR_SUCCESS, dan mengatur nilai yang ditujukkan oleh parameter ulLength ke jumlah byte yang disalin ke dalam pbData.

Ketika akhir file cadangan tercapai, atur ulLength ke nol untuk memberi tahu sistem bahwa seluruh file telah diproses.

Jika fungsi gagal, atur nilai pengembalian ke kode kesalahan bukan nol yang ditentukan dalam WinError.h. Misalnya, jika fungsi ini gagal karena API yang dipanggilnya gagal, Anda dapat mengatur nilai pengembalian ke nilai yang dikembalikan oleh GetLastError untuk API yang gagal.

Keterangan

Sistem memanggil fungsi ImportCallback hingga fungsi panggilan balik menunjukkan tidak ada lagi data yang akan dipulihkan. Untuk menunjukkan bahwa tidak ada lagi data yang akan dipulihkan, atur *ulLength ke 0 dan gunakan kode pengembalian ERROR_SUCCESS. Anda dapat menggunakan blok konteks yang ditentukan aplikasi untuk pelacakan internal informasi seperti handel file dan offset saat ini dalam file.

Persyaratan


Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	winbase.h (termasuk Windows.h)