IO_SESSION_NOTIFICATION_FUNCTION fungsi panggilan balik (wdm.h)

Artikel
03/08/2023

Jenis fungsi IO_SESSION_NOTIFICATION_FUNCTION mendefinisikan rutinitas panggilan balik di mana driver menerima pemberitahuan tentang perubahan status sesi pengguna yang diminati driver.

Sintaks

IO_SESSION_NOTIFICATION_FUNCTION IoSessionNotificationFunction;

NTSTATUS IoSessionNotificationFunction(
  [in] PVOID SessionObject,
  [in] PVOID IoObject,
  [in] ULONG Event,
  [in] PVOID Context,
  [in] PVOID NotificationPayload,
  [in] ULONG PayloadLength
)
{...}

Parameter

[in] SessionObject

Penunjuk ke objek sistem buram yang berisi informasi tentang sesi pengguna. Driver dapat meneruskan nilai pointer ini ke rutinitas IoGetContainerInformation sebagai nilai parameter ContainerObject .

[in] IoObject

Arahkan ke objek I/O yang dimiliki oleh driver. Parameter ini adalah penunjuk objek I/O yang disediakan driver ke rutinitas IoRegisterContainerNotification ketika driver sebelumnya terdaftar untuk menerima pemberitahuan peristiwa sesi. Parameter NotificationInformation rutin IoRegisterContainerNotification menunjuk ke struktur IO_SESSION_STATE_NOTIFICATION yang anggota IoObject-nya menunjuk ke objek I/O.

[in] Event

Konstanta enumerasi IO_SESSION_EVENT yang menunjukkan peristiwa sesi mana yang menyebabkan panggilan balik pemberitahuan.

[in] Context

Nilai konteks yang sebelumnya diberikan driver ke rutinitas IoRegisterContainerNotification ketika driver terdaftar untuk menerima pemberitahuan peristiwa sesi. Dalam panggilan IoRegisterContainerNotification , driver menyediakan penunjuk ke struktur IO_SESSION_STATE_NOTIFICATION yang anggota Konteksnya berisi nilai konteks.

[in] NotificationPayload

Penunjuk ke buffer payload yang berisi struktur IO_SESSION_CONNECT_INFO .

[in] PayloadLength

Ukuran, dalam byte, dari buffer yang diacu oleh NotificationPayload. Ukuran buffer tidak pernah perlu melebihi nilai konstanta IO_SESSION_MAX_PAYLOAD_SIZE, yang didefinisikan dalam file header Wdm.h.

Nilai kembali

Jika rutinitas berhasil, rutinitas harus mengembalikan STATUS_SUCCESS. Jika tidak, itu harus mengembalikan salah satu nilai status kesalahan yang ditentukan dalam file header Ntstatus.h.

Keterangan

Driver mode kernel mengimplementasikan rutinitas ini. Manajer I/O memanggil rutinitas ini untuk memberi tahu driver peristiwa sesi.

Untuk menerima pemberitahuan peristiwa sesi, driver memanggil rutinitas IoRegisterContainerNotification dan mengatur parameter CallbackFunction rutin ini untuk menunjuk ke rutinitas IO_SESSION_NOTIFICATION_FUNCTION driver. Objek I/O yang diteruskan driver ke IoRegisterContainerNotification menentukan apakah driver akan menerima pemberitahuan peristiwa dalam sesi pengguna tertentu atau peristiwa di semua sesi. Untuk informasi selengkapnya, lihat IO_SESSION_STATE_NOTIFICATION.

Contoh

Untuk menentukan rutinitas pemberitahuan sesi I/O, Anda harus terlebih dahulu memberikan deklarasi fungsi yang mengidentifikasi jenis rutinitas panggilan balik yang Anda tentukan. Windows menyediakan sekumpulan tipe fungsi panggilan balik untuk driver. Mendeklarasikan fungsi menggunakan jenis fungsi panggilan balik membantu Analisis Kode untuk Driver, Pemverifikasi Driver Statis (SDV), dan alat verifikasi lainnya menemukan kesalahan, dan itu adalah persyaratan untuk menulis driver untuk sistem operasi Windows.

Misalnya, untuk menentukan rutinitas pemberitahuan sesi I/O yang diberi nama MyIoSessionNotification, gunakan jenis IO_SESSION_NOTIFICATION_FUNCTION seperti yang ditunjukkan dalam contoh kode ini:

IO_SESSION_NOTIFICATION_FUNCTION MyIoSessionNotification;

Kemudian, terapkan rutinitas panggilan balik Anda sebagai berikut:

_Use_decl_annotations_
NTSTATUS
  MyIoSessionNotification(
    PVOID  SessionObject,
    PVOID  IoObject,
    ULONG  Event,
    PVOID  Context,
    PVOID  NotificationPayload,
    ULONG  PayloadLength
    )
  {
      // Function body
  }

Jenis fungsi IO_SESSION_NOTIFICATION_FUNCTION didefinisikan dalam file header Wdm.h. Untuk mengidentifikasi kesalahan secara lebih akurat saat Anda menjalankan alat analisis kode, pastikan untuk menambahkan _Use_decl_annotations_ anotasi ke definisi fungsi Anda. Anotasi _Use_decl_annotations_ memastikan bahwa anotasi yang diterapkan ke jenis fungsi IO_SESSION_NOTIFICATION_FUNCTION dalam file header digunakan. Untuk informasi selengkapnya tentang persyaratan untuk deklarasi fungsi, lihat Mendeklarasikan Fungsi dengan Menggunakan Jenis Peran Fungsi untuk Driver WDM. Untuk informasi tentang _Use_decl_annotations_, lihat Menganotasi Perilaku Fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Didukung di Windows 7 dan versi yang lebih baru dari sistem operasi Windows.
Target Platform	Desktop
Header	wdm.h (termasuk Wdm.h, Ntddk.h, Ntifs.h, Fltkernel.h)
IRQL	Dipanggil di IRQL <= APC_LEVEL.