NdisInitializeEvent function (ndis.h)

Article
02/22/2024

The NdisInitializeEvent function sets up an event object during driver initialization to be used subsequently as a synchronization mechanism.

Syntax

void NdisInitializeEvent(
  [out] PNDIS_EVENT Event
);

Parameters

[out] Event

A pointer to caller-supplied storage for the event object, which is opaque to drivers.

Return value

None

Remarks

The NdisInitializeEvent function creates an event object that has an event type of NotificationEvent and an initial state of not-signaled. For more information about notification events, see Defining and Using an Event Object.

The Event pointer passed to NdisInitializeEvent is a required parameter to all other NdisXxxEvent functions.

While driver functions that must run at IRQL <= DISPATCH_LEVEL can call the NdisSetEvent and NdisResetEvent functions ,calling NdisWaitEvent from any IRQL > PASSIVE_LEVEL is a fatal error.

Requirements

Requirement	Value
Minimum supported client	Supported for NDIS 6.0 and NDIS 5.1 drivers (see NdisInitializeEvent (NDIS 5.1)) in Windows Vista. Supported for NDIS 5.1 drivers (see NdisInitializeEvent (NDIS 5.1)) in Windows XP.
Target Platform	Universal
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	Any level