Metode IKsControl::KsEvent (ksproxy.h)

Artikel
02/29/2024

Metode KsEvent memungkinkan atau menonaktifkan peristiwa, bersama dengan operasi dukungan lain yang ditentukan yang tersedia pada set peristiwa.

Sintaks

HRESULT KsEvent(
  [in, optional] PKSEVENT Event,
  [in]           ULONG    EventLength,
  [in, out]      LPVOID   EventData,
  [in]           ULONG    DataLength,
  [in, out]      ULONG    *BytesReturned
);

Parameter

[in, optional] Event

Penunjuk ke struktur KSEVENT yang menjelaskan peristiwa untuk mengaktifkan peristiwa dan NULL untuk menonaktifkan peristiwa.

[in] EventLength

Ukuran, dalam byte, buffer di Peristiwa saat peristiwa diaktifkan dan nol saat peristiwa dinonaktifkan.

[in, out] EventData

Penunjuk ke struktur KSEVENTDATA yang berisi data untuk peristiwa dan ruang buffer yang menerima data untuk peristiwa tersebut.

[in] DataLength

Ukuran, dalam byte, dari buffer di EventData.

[in, out] BytesReturned

Penunjuk ke variabel yang menerima ukuran, dalam byte, dari data yang disimpan KsEvent di buffer di EventData.

Nilai kembali

Mengembalikan NOERROR jika berhasil; jika tidak, mengembalikan kode kesalahan. Jika panggilan berhasil, peristiwa ada di daftar peristiwa driver.

Keterangan

Untuk menonaktifkan peristiwa, atur Peristiwa ke NULL, EventLength ke nol, dan EventData ke penunjuk ke struktur KSEVENTDATA yang sebelumnya digunakan untuk mengaktifkan peristiwa.

Parameter EventData dari IKsControl::KsEvent berisi handel di EventHandle.Event. Anda dapat menunggu handel tersedia dan mendapatkan pemberitahuan saat minidriver memanggil KsXxxGenerateEvents atau StreamClassStreamNotification.