KsGenerateDataEvent, fonction (ks.h)

La fonction KsGenerateDataEvent génère l’une des notifications d’événements standard lorsqu’une structure d’entrée d’événement et des données de rappel sont fournies. Cela permet à un appareil de déterminer quand les notifications d’événements doivent être générées, tout en continuant d’utiliser cette fonction d’assistance pour effectuer la notification réelle.

Syntaxe

KSDDKAPI NTSTATUS KsGenerateDataEvent(
  [in] PKSEVENT_ENTRY EventEntry,
  [in] ULONG          DataSize,
  [in] PVOID          Data
);

Paramètres

[in] EventEntry

Spécifie la structure d’entrée d’événement qui référence les données d’événement. Les informations sont utilisées pour déterminer le type de notification à effectuer. Si le type de notification ne fait pas partie des normes prédéfinies, une erreur est retournée. Dans le cas d’un événement unique et non récupérant, cette entrée n’est pas valide lorsqu’elle est retournée à partir de la fonction . Par conséquent, tout code qui énumère une liste d’événements doit être préincréé pour acquérir l’événement suivant dans la liste avant de transmettre cet événement à la fonction .

[in] DataSize

Spécifie la taille en octets du paramètre Data passé.

[in] Data

Pointe vers les données à passer au rappel client. Ces données sont copiées dans l’un des emplacements de mémoire tampon préalloués configurés lorsque l’événement a été activé. La taille des données doit être inférieure à celle qui a été allouée à l’origine, sinon l’événement échoue.

Valeur retournée

La fonction KsGenerateDataEvent retourne STATUS_SUCCESS en cas de réussite, ou en cas d’échec, elle retourne une exception ou une erreur de mémoire.

Remarques

Il est supposé que le verrou de liste d’événements a été acquis avant l’appel de cette fonction. Cette fonction peut entraîner un appel au RemoveHandler pour l’entrée d’événement. Par conséquent, la fonction ne doit pas être appelée à une valeur supérieure au niveau IRQ du verrou, ou la fonction Remove doit être en mesure de gérer l’appel à ce niveau.

Cette fonction est spécifiquement destinée aux événements qui transmettent des données par le biais d’un rappel à un client.

Configuration requise

Voir aussi

KSBUFFER_ITEM