Fungsi WofIsExternalFile (wofapi.h)

Artikel
03/08/2023

Digunakan untuk menentukan apakah file didukung oleh file fisik atau didukung oleh penyedia data sistem, dan secara opsional menunjukkan penyedia mana atau data tambahan tentang file.

Sintaks

HRESULT WofIsExternalFile(
  [in]                LPCWSTR FilePath,
  [out, optional]     PBOOL   IsExternalFile,
  [out, optional]     PULONG  Provider,
  [out, optional]     PVOID   ExternalFileInfo,
  [in, out, optional] PULONG  BufferLength
);

Parameter

[in] FilePath

Menentukan jalur ke file yang status pencadangannya diinginkan.

[out, optional] IsExternalFile

Secara opsional menunjuk ke nilai BOOL. Saat berhasil dikembalikan, nilai ini akan true jika objek didukung secara eksternal, FALSE jika merupakan file fisik.

[out, optional] Provider

Secara opsional menunjuk ke nilai ULONG. Jika berhasil dikembalikan, nilai ini akan diatur ke penyedia yang secara eksternal mendukung objek ini. Penyedia yang saat ini ditentukan adalah:

WOF_PROVIDER_WIM	Menunjukkan bahwa data untuk file berada dalam file WIM terpisah. Pada akses, data diekstraksi secara transparan, didekompresi, dan disediakan untuk aplikasi. Jika konten file dimodifikasi, data didekompresi secara transparan dan file dipulihkan ke file biasa.
WOF_PROVIDER_FILE	Menunjukkan bahwa data untuk file harus dikompresi dan disimpan dengan file itu sendiri. Pada akses, data didekompresi secara transparan dan disediakan untuk aplikasi. Jika konten file dimodifikasi, data didekompresi secara transparan dan file dipulihkan ke file biasa. Penyedia ini memerlukan Windows 10.

[out, optional] ExternalFileInfo

Secara opsional menunjuk ke buffer yang dialokasikan pemanggil. Saat pengembalian berhasil, buffer ini akan berisi informasi tambahan tentang status file. Jika nilai ini disediakan, BufferLength juga harus ditentukan. Struktur data untuk setiap penyedia yang ditentukan adalah:

WOF_PROVIDER_WIM	WIM_EXTERNAL_FILE_INFO
WOF_PROVIDER_FILE	WOF_FILE_COMPRESSION_INFO

[in, out, optional] BufferLength

Secara opsional menunjuk ke nilai yang berisi panjang buffer yang ditentukan dalam ExternalFileInfo. Saat dikembalikan, nilai ini akan diatur ke ukuran buffer yang digunakan, atau ukuran buffer yang diperlukan. Jika buffer memiliki panjang yang tidak memadai, fungsi ini akan berhasil menunjukkan ukuran yang diperlukan dan tidak akan mengisi buffer di ExternalFileInfo. Panjang ini harus sesuai dengan salah satu struktur yang ditentukan di atas:

WOF_PROVIDER_WIM	sizeof(WIM_EXTERNAL_FILE_INFO)
WOF_PROVIDER_FILE	sizeof(WOF_FILE_COMPRESSION_INFO)

Mengembalikan nilai

Fungsi ini mengembalikan HRESULT yang menunjukkan keberhasilan atau alasan kegagalan. Jika buffer yang ditentukan dalam ExternalFileInfo tidak berukuran benar, fungsi akan mengembalikan S_OK dan menunjukkan ukuran buffer yang diperlukan di BufferLength.

Persyaratan

Persyaratan	Nilai
Target Platform	Windows
Header	wofapi.h
Pustaka	Wofutil.lib
DLL	Wofutil.dll

Lihat juga

FSCTL_GET_EXTERNAL_BACKING

Share via