StreamClassGetNextEvent, fonction (strmini.h)

Les minidrivers peuvent utiliser la routine StreamClassGetNextEvent pour rechercher la file d’attente d’événements d’un appareil ou d’un flux particulier.

Syntaxe

PKSEVENT_ENTRY StreamClassGetNextEvent(
  [in, optional] PVOID             HwInstanceExtension_OR_HwDeviceExtension,
  [in, optional] PHW_STREAM_OBJECT HwStreamObject,
  [in, optional] GUID              *EventGuid,
  [in]           ULONG             EventItem,
  [in, optional] PKSEVENT_ENTRY    CurrentEvent
);

Paramètres

[in, optional] HwInstanceExtension_OR_HwDeviceExtension

Pointeur vers l’extension d’appareil du minidriver. Le minidriver spécifie la taille de cette mémoire tampon dans la structure HW_INITIALIZATION_DATA qu’il transmet lorsqu’il s’inscrit via StreamClassRegisterMinidriver. Le pilote de classe passe ensuite des pointeurs vers la mémoire tampon dans le HwDeviceExtension membre du HW_STREAM_REQUEST_BLOCK, HW_STREAM_OBJECT, HW_TIME_CONTEXTet PORT_CONFIGURATION_INFORMATION structures qu’il transmet au minidriver.

Ce premier paramètre était PVOID HwDeviceExtension. Il doit s’agir de HwInstanceExtension pour les pilotes multi-instances et multi-filtres (version 20). Les pilotes d’instance unique hérités peuvent continuer à spécifier HwDeviceExtension comme premier paramètre. Il peut également spécifier HwInstanceExtension.

[in, optional] HwStreamObject

Pointeur vers un HW_STREAM_OBJECT. Définissez la valeur NULL pour rechercher la file d’attente d’événements de l’appareil lui-même. Pour rechercher la file d’attente d’événements d’un flux particulier, définissez sur l’objet de flux du flux.

[in, optional] EventGuid

Spécifie le jeu d’événements à mettre en correspondance lors de la marche de la file d’attente, ou NULL pour qu’il corresponde à n’importe quel jeu d’événements.

[in] EventItem

Spécifie l’ID d’événement à mettre en correspondance lors de la marche de la file d’attente, ou -1 pour qu’il corresponde à un événement.

[in, optional] CurrentEvent

Pointeur vers un événement dans la file d’attente d’événements ou NULL .

Valeur de retour

Si CurrentEvent n’est pas NULL, StreamClassGetNextEvent retourne l’événement correspondant suivant après CurrentEvent dans la file d’attente (ou NULL s’il n’existe aucun événement suivant). Si CurrentEvent est NULL, StreamClassGetNextEvent retourne le premier événement correspondant dans la file d’attente.

Remarques

Le minidriver peut appeler StreamClassGetNextEvent successivement pour parcourir la file d’attente d’événements, en examinant un événement à la fois.

L’appelant peut spécifier des critères de recherche supplémentaires pour correspondre aux événements dans la file d’attente d’événements.

Exigences