PFN_WSK_CLIENT_EVENT Rückruffunktion (wsk.h)

  • Artikel

Die WskClientEvent-Ereignisrückruffunktion benachrichtigt eine WSK-Anwendung über Ereignisse, die nicht für einen bestimmten Socket spezifisch sind.

Syntax

PFN_WSK_CLIENT_EVENT PfnWskClientEvent;

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

Parameter

[in, optional] ClientContext

Ein Zeiger auf den Kontextwert, der vom WskClientNpi-Parameter angegeben wurde, der an die WskRegister-Funktion übergeben wurde.

[in] EventType

Das spezifische Ereignis, über das die WSK-Anwendung benachrichtigt wird. Derzeit sind keine Ereignisse definiert.

[in, optional] Information

Ein Zeiger auf einen Puffer, der zusätzliche Informationen enthält, die dem Ereignis zugeordnet sind. Wenn dem Ereignis keine zusätzlichen Informationen zugeordnet sind, ist dieser Zeiger NULL.

[in] InformationLength

Die Länge der zusätzlichen Informationen, die im Puffer enthalten sind, auf den vom
Informationsparameter . Wenn dem Ereignis keine zusätzlichen Informationen zugeordnet sind, ist dieser Wert 0.

Rückgabewert

Die WskClientEvent-Ereignisrückruffunktion einer WSK-Anwendung kann einen der folgenden NTSTATUS-Codes zurückgeben:

Rückgabecode Beschreibung
STATUS_SUCCESS
 Die Ereignisbenachrichtigung wurde erfolgreich verarbeitet.
STATUS_NOT_IMPLEMENTED
 Die Unterstützung für das Ereignis, das im Ereignisparameter übergeben wird, wird nicht implementiert.

Hinweise

Derzeit sind keine Ereignisse für die WskClientEvent-Ereignisrückruffunktion definiert. Wenn eine WSK-Anwendung daher eine WskClientEvent-Ereignisrückruffunktion implementiert, sollte sie immer STATUS_NOT_IMPLEMENTED zurückgeben.

Die zusätzlichen Informationen, die im Puffer enthalten sind, auf den der Parameter Information verweist, sind schreibgeschützt und nur für die Dauer des Aufrufs der WskClientEvent-Ereignisrückruffunktion gültig.

Wenn eine WSK-Anwendung keine WskClientEvent-Ereignisrückruffunktion implementiert, sollte sie das WskClientEvent-Element der WSK_CLIENT_DISPATCH Struktur auf NULL festlegen, bevor WskRegister aufgerufen wird.

Das WSK-Subsystem ruft die WskClientEvent-Ereignisrückruffunktion einer WSK-Anwendung unter IRQL <= DISPATCH_LEVEL auf.

Die WskClientEvent-Ereignisrückruffunktion einer WSK-Anwendung darf nicht auf den Abschluss anderer WSK-Anforderungen im Kontext von WSK-Vervollständigungs- oder Ereignisrückruffunktionen warten. Der Rückruf kann andere WSK-Anforderungen initiieren (vorausgesetzt, er verbringt nicht zu viel Zeit mit DISPATCH_LEVEL), darf aber nicht auf deren Abschluss warten, auch wenn der Rückruf unter IRQL = PASSIVE_LEVEL aufgerufen wird.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Verfügbar in Windows Vista und höheren Versionen der Windows-Betriebssysteme.
Zielplattform Windows
Kopfzeile wsk.h (einschließen von Wsk.h)
IRQL <= DISPATCH_LEVEL

Weitere Informationen

WSK_CLIENT_DISPATCH

WskRegister