Fungsi SetupScanFileQueueW (setupapi.h)

[Fungsi ini tersedia untuk digunakan dalam sistem operasi yang ditunjukkan di bagian Persyaratan. Ini mungkin diubah atau tidak tersedia dalam versi berikutnya. SetupAPI tidak boleh lagi digunakan untuk menginstal aplikasi. Sebagai gantinya, gunakan Penginstal Windows untuk mengembangkan penginstal aplikasi. PenyetelanAPI terus digunakan untuk menginstal pengandar perangkat.]

Fungsi SetupScanFileQueue memindai antrean file penyiapan, melakukan operasi pada setiap simpul dalam daftar salinannya. Operasi ditentukan oleh sekumpulan bendera. Fungsi ini dapat dipanggil baik sebelum atau sesudah antrean dilakukan.

Sintaksis

WINSETUPAPI BOOL SetupScanFileQueueW(
  [in]  HSPFILEQ            FileQueue,
  [in]  DWORD               Flags,
  [in]  HWND                Window,
  [in]  PSP_FILE_CALLBACK_W CallbackRoutine,
  [in]  PVOID               CallbackContext,
  [out] PDWORD              Result
);

Parameter

[in] FileQueue

Tangani ke antrean file penyetelan yang daftar salinannya akan dipindai atau diulang.

[in] Flags

Bendera untuk digabungkan untuk mengontrol operasi pemindaian antrean file. Perhatikan bahwa SPQ_SCAN_FILE_PRESENCE, SPQ_SCAN_USE_CALLBACK, SPQ_SCAN_USE_CALLBACKEX, atau SPQ_SCAN_FILE_VALIDITY harus ditentukan.

Bendera	Arti
SPQ_SCAN_FILE_PRESENCE	File target dalam antrean salin sudah ada pada target.
SPQ_SCAN_FILE_VALIDITY	File target dalam antrean salin sudah ada pada target dengan tanda tangan yang valid. Tersedia dengan Windows 2000 dan versi yang lebih baru.
SPQ_SCAN_USE_CALLBACK	Rutinitas panggilan balik untuk setiap simpul antrean. Jika rutinitas panggilan balik mengembalikan nilai bukan nol, pemrosesan antrean berhenti dan SetupScanFileQueue mengembalikan nol. Terbitkan kode pemberitahuan SPFILENOTIFY_QUEUESCAN dan teruskan penunjuk ke jalur target sebagai Param1.
SPQ_SCAN_USE_CALLBACKEX	Rutinitas panggilan balik untuk setiap simpul antrean. Jika rutinitas panggilan balik mengembalikan nilai bukan nol, pemrosesan antrean berhenti dan SetupScanFileQueue mengembalikan nol. Terbitkan pemberitahuan SPFILENOTIFY_QUEUESCAN_EX dan teruskan penunjuk ke struktur FILEPATHS sebagai Param1. SPQ_SCAN_USE_CALLBACKEX juga memeriksa bahwa file memiliki tanda tangan yang valid. Tersedia dimulai dengan Windows 2000. Hanya pada Windows XP, Anda dapat menonaktifkan pemeriksaan tanda tangan dengan menggabungkan bendera ini dengan SPQ_SCAN_FILE_PRESENCE.
SPQ_SCAN_INFORM_USER	Bendera ditentukan ketika semua file dalam antrean melewati pemeriksaan tanda tangan yang valid. SetupScanFileQueue memberi tahu pengguna bahwa operasi memerlukan file yang sudah ada pada target. Bendera ini diabaikan jika SPQ_SCAN_FILE_PRESENCE atau SPQ_SCAN_FILE_VALIDITY tidak ditentukan. Bendera ini mungkin tidak digunakan dengan SPQ_SCAN_PRUNE_COPY_QUEUE atau SPQ_SCAN_PRUNE_DELREN.
SPQ_SCAN_PRUNE_COPY_QUEUE	Dikombinasikan dengan SPQ_SCAN_FILE_PRESENCE, menghapus entri yang ada dari antrean salin. Ketika dikombinasikan dengan SPQ_SCAN_FILE_VALIDITY, menghapus entri yang ditandatangani dari antrean salin. Tersedia dimulai dengan Windows 2000. Hanya pada Windows XP, file yang juga ditentukan dalam antrean penghapusan atau antrean penggantian nama tidak diprajakan kecuali SPQ_SCAN_PRUNE_DELREN ditentukan.
SPQ_SCAN_USE_CALLBACK_SIGNERINFO	Tersedia dimulai dengan Windows XP. Masalah SPFILENOTIFY_QUEUESCAN_SIGNERINFO pemberitahuan dan meneruskan penunjuk ke struktur FILEPATHS_SIGNERINFO sebagai Param1. Memeriksa setiap file untuk tanda tangan yang valid dan melaporkan informasi tanda tangan melalui fungsi panggilan balik.
SPQ_SCAN_PRUNE_DELREN	Dikombinasikan dengan SPQ_SCAN_FILE_PRESENCE atau SPQ_SCAN_FILE_VALIDITY, menghapus entri dalam antrean hapus atau ganti nama yang juga ada dalam antrean salin. Ketika dikombinasikan dengan SPQ_SCAN_PRUNE_COPY_QUEUE, membatasi file yang dihapus dari antrean salin ke file yang tidak ada dalam antrean hapus atau ganti nama. Tersedia dimulai dengan Windows XP.

[in] Window

Handel opsional ke jendela untuk memiliki kotak dialog yang disajikan. Parameter ini tidak digunakan jika parameter Bendera tidak berisi SPQ_SCAN_FILE_PRESENCE atau jika bendera tidak berisi SPQ_SCAN_INFORM_USER.

[in] CallbackRoutine

Penunjuk opsional ke fungsi panggilan balik FileCallback untuk dipanggil pada setiap simpul antrean salin. Kode pemberitahuan yang diteruskan ke fungsi panggilan balik SPFILENOTIFY_QUEUESCAN. Parameter ini diperlukan jika Bendera menyertakan SPQ_SCAN_USE_CALLBACK.

Catatan Anda harus menyediakan rutinitas panggilan balik yang ditentukan oleh CallbackRoutine. Rutinitas panggilan balik antrean default tidak mendukung SetupScanFileQueue.

 

[in] CallbackContext

Penunjuk opsional ke konteks yang berisi data yang ditentukan pemanggil yang diteruskan ke rutinitas panggilan balik yang diarahkan ke CallbackRoutine.

[out] Result

Penunjuk ke variabel yang menerima hasil operasi pemindaian.

Mengembalikan nilai

Fungsi mengembalikan nilai bukan nol jika semua simpul dalam antrean diproses.

Jika bendera SPQ_SCAN_USE_CALLBACK diatur, nilai dalam Hasil adalah 0. Rutinitas panggilan balik yang ditentukan oleh CallbackRoutine dikirim SPFILENOTIFY_QUEUESCAN pemberitahuan. CallbackRoutine.Param1 menentukan penunjuk ke array yang berisi informasi jalur target. Penunjuk telah ditransmisikan ke bilangan bulat yang tidak ditandatangani dan harus diprakirakan ulang ke array TCHAR elemen MAX_PATH sebelum rutinitas panggilan balik dapat mengakses informasi. CallbackRoutine.Param2 diatur ke SPQ_DELAYED_COPY jika simpul antrean saat ini sedang digunakan dan tidak dapat disalin hingga sistem dimulai ulang. Jika tidak, CallbackRoutine.Param2 mengambil nilai 0.

Jika SPQ_SCAN_USE_CALLBACK tidak diatur, Hasil menunjukkan apakah antrean melewati pemeriksaan kehadiran atau validitas seperti yang ditunjukkan dalam tabel berikut.

Mengembalikan kode	Deskripsi
0	Antrean gagal memeriksa atau melewati pemeriksaan, tetapi SPQ_SCAN_INFORM_USER ditentukan dan pengguna menginginkan salinan file baru.
1	Antrean melewati pemeriksaan dan, jika SPQ_SCAN_INFORM_USER ditentukan, pengguna menunjukkan bahwa penyalinan tidak diperlukan. Antrean salin kosong dan tidak ada elemen pada antrean hapus atau ganti nama, sehingga pemanggil dapat melewati penerapan antrean.
2	Antrean melewati pemeriksaan dan, jika SPQ_SCAN_INFORM_USER ditentukan, pengguna menunjukkan bahwa penyalinan tidak diperlukan. Antrean salin kosong, tetapi ada elemen pada antrean hapus atau ganti nama, sehingga pemanggil tidak dapat melewati penerapan antrean.

 

Fungsi mengembalikan nol jika terjadi kesalahan atau fungsi panggilan balik mengembalikan nonzero. Jika Result bukan nol, itu adalah nilai yang dikembalikan oleh fungsi panggilan balik yang menghentikan pemrosesan antrean. Jika Hasil nol, informasi kesalahan yang diperluas dapat diambil dengan panggilan ke GetLastError.

Komentar

Nota

Header setupapi.h mendefinisikan SetupScanFileQueue sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta praprosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Syarat	Nilai
klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Platform Target	Windows
Header	setupapi.h
Pustaka	Setupapi.lib
DLL	Setupapi.dll

Lihat juga

FileCallback

Functions

Gambaran Umum

SetupCommitFileQueue

SetupDefaultQueueCallback