Metode IWDFIoQueue::P urge (wudfddi.h)

Artikel
03/01/2024

[Peringatan: UMDF 2 adalah versi terbaru UMDF dan pengganti UMDF 1. Semua driver UMDF baru harus ditulis menggunakan UMDF 2. Tidak ada fitur baru yang ditambahkan ke UMDF 1 dan ada dukungan terbatas untuk UMDF 1 pada versi Windows 10 yang lebih baru. Driver Universal Windows harus menggunakan UMDF 2. Untuk informasi selengkapnya, lihat Mulai menggunakan UMDF.]

Metode Hapus Menyeluruh mengarahkan kerangka kerja untuk menolak permintaan I/O masuk baru dan membatalkan semua permintaan yang luar biasa.

Sintaks

void Purge(
  [in, optional] IQueueCallbackStateChange *pPurgeComplete
);

Parameter

[in, optional] pPurgeComplete

Penunjuk ke antarmuka IQueueCallbackStateChange yang metodenya dipanggil kerangka kerja untuk mengirimkan status antrean ke driver. Kerangka kerja memanggil metode setelah semua permintaan dibatalkan. Parameter ini bersifat opsional dan dapat berupa NULL.

Nilai kembali

Tidak ada

Keterangan

Kerangka kerja membatalkan permintaan yang tidak diolah dalam antrean. Untuk permintaan yang dikirimkan ke driver dan ditandai dapat dibatalkan, kerangka kerja memanggil IRequestCallbackCancel::OnCancel.

Driver harus memastikan bahwa hanya salah satu metode berikut yang sedang berlangsung pada waktu tertentu:

IWDFIoQueue::Stop
IWDFIoQueue::D rain
IWDFIoQueue::P urge

Misalnya, jika driver yang sebelumnya disebut Hapus Menyeluruh, itu harus menunggu pemberitahuan dari metode antarmuka yang ditunjukkan parameter pPurgeComplete sebelum memanggil Stop atau Drain. Melanggar aturan ini menghasilkan penghentian proses host.

Contoh

Contoh kode berikut menunjukkan cara menghentikan permintaan ke antrean.

VOID
CUmdfHidFile::OnCleanupFile(
    __in IWDFFile* /* WdfFile */
    )
/*++
    This method handles the cleanup operation for the file object.  
    Because the file is disabled, no new reports should be added to the ring buffer.
--*/
{
    this->Disable();

    //
    // Stop all current requests to read reports.
    //

    m_GetReportQueue->Purge(NULL);
}

Persyaratan

Persyaratan	Nilai
Akhir dukungan	Tidak tersedia di UMDF 2.0 dan yang lebih baru.
Target Platform	Desktop
Versi UMDF minimum	1,5
Header	wudfddi.h (termasuk Wudfddi.h)
DLL	WUDFx.dll