Méthode IKsControl ::KsEvent (ksproxy.h)

Article
02/29/2024

La méthode KsEvent active ou désactive un événement, ainsi que toutes les autres opérations de support définies disponibles sur un jeu d’événements.

Syntaxe

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

Paramètres

[in, optional] Event

Pointeur vers une structure KSEVENT qui décrit un événement pour activer l’événement et NULL pour désactiver l’événement.

[in] EventLength

Taille, en octets, de la mémoire tampon sur Événement lorsque l’événement est activé et zéro lorsque l’événement est désactivé.

[in, out] EventData

Pointeur vers une structure KSEVENTDATA qui contient des données pour l’événement et l’espace tampon qui reçoit les données de l’événement.

[in] DataLength

Taille, en octets, de la mémoire tampon dans EventData.

[in, out] BytesReturned

Pointeur vers une variable qui reçoit la taille, en octets, des données que KsEvent stocke dans la mémoire tampon sur EventData.

Valeur retournée

Retourne NOERROR en cas de réussite ; sinon, retourne un code d’erreur. Si l’appel réussit, l’événement figure dans la liste des événements du pilote.

Remarques

Pour désactiver un événement, définissez Event sur NULL, EventLength sur zéro et EventData sur le pointeur vers la structure KSEVENTDATA qui était précédemment utilisée pour activer l’événement.

Le paramètre EventDatad’IKsControl ::KsEvent contient un handle dans EventHandle.Event. Vous pouvez attendre que le handle soit disponible et recevoir des notifications lorsque le minidriver appelle KsXxxGenerateEvents ou StreamClassStreamNotification.