fonction de rappel PFN_WSK_CLIENT_EVENT (wsk.h)

Article
03/01/2024

La fonction de rappel d’événement WskClientEvent avertit une application WSK des événements qui ne sont pas spécifiques à un socket particulier.

Syntaxe

PFN_WSK_CLIENT_EVENT PfnWskClientEvent;

NTSTATUS PfnWskClientEvent(
  [in, optional] PVOID ClientContext,
  [in]           ULONG EventType,
  [in, optional] PVOID Information,
  [in]           SIZE_T InformationLength
)
{...}

Paramètres

[in, optional] ClientContext

Pointeur vers la valeur de contexte spécifiée par le paramètre WskClientNpi passé à la fonction WskRegister .

[in] EventType

Événement spécifique au sujet duquel l’application WSK est avertie. Aucun événement n’est actuellement défini.

[in, optional] Information

Pointeur vers une mémoire tampon qui contient des informations supplémentaires associées à l’événement. Si aucune information supplémentaire n’est associée à l’événement, ce pointeur est NULL.

[in] InformationLength

Longueur des informations supplémentaires contenues dans la mémoire tampon pointée par le
Paramètre d’informations . Si aucune information supplémentaire n’est associée à l’événement, cette valeur est égale à zéro.

Valeur retournée

La fonction de rappel d’événement WskClientEvent d’une application WSK peut retourner l’un des codes NTSTATUS suivants :

Code de retour	Description
STATUS_SUCCESS	La notification d’événement a été traitée avec succès.
STATUS_NOT_IMPLEMENTED	La prise en charge de l’événement passé dans le paramètre Event n’est pas implémentée.

Remarques

Actuellement, aucun événement n’est défini pour la fonction de rappel d’événement WskClientEvent . Par conséquent, si une application WSK implémente une fonction de rappel d’événement WskClientEvent , elle doit toujours retourner STATUS_NOT_IMPLEMENTED.

Les informations supplémentaires contenues dans la mémoire tampon pointées par le paramètre Information sont en lecture seule et valides uniquement pendant la durée de l’appel à la fonction de rappel d’événement WskClientEvent .

Si une application WSK n’implémente pas de fonction de rappel d’événement WskClientEvent , elle doit définir le membre WskClientEvent de la structure WSK_CLIENT_DISPATCH sur NULL avant d’appeler WskRegister.

Le sous-système WSK appelle la fonction de rappel d’événement WskClientEvent d’une application WSK à l’adresse IRQL <= DISPATCH_LEVEL.

La fonction de rappel d’événement WskClientEvent d’une application WSK ne doit pas attendre l’achèvement d’autres requêtes WSK dans le contexte de l’achèvement WSK ou des fonctions de rappel d’événements. Le rappel peut lancer d’autres requêtes WSK (en supposant qu’il ne passe pas trop de temps à DISPATCH_LEVEL), mais il ne doit pas attendre leur achèvement même lorsque le rappel est appelé à IRQL = PASSIVE_LEVEL.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows Vista et versions ultérieures des systèmes d’exploitation Windows.
Plateforme cible	Windows
En-tête	wsk.h (inclure Wsk.h)
IRQL	<= DISPATCH_LEVEL

Voir aussi

WSK_CLIENT_DISPATCH

WskRegister

Partager via