NdisWaitEvent

NdisWaitEvent puts the caller into a wait state until the given event is set to the Signaled state or the wait times out.

BOOLEAN
  NdisWaitEvent(
    IN PNDIS_EVENT  Event,
    IN UINT  MsToWait
    ); 

Parameters

Event

Pointer to an initialized event object for which the caller provides the storage.

MsToWait

Specifies the number of milliseconds the caller will wait if the event is not set to the Signaled state within that interval. A value of zero specifies that the caller will wait for the event indefinitely.

Return Value

NdisWaitEvent returns TRUE if the event is in the Signaled state when the wait is satisfied.

Headers

Declared in Ndis.h. Include Ndis.h.

Comments

NdisWaitEvent returns control to its caller when the given event is signaled or the specified MsToWait interval expires, whichever is sooner. If the event is currently in the Signaled state when this call occurs, NdisWaitEvent returns control immediately.

A miniport driver typically calls NdisWaitEvent from its MiniportInitialize and MiniportHalt functions. A protocol driver typically calls NdisWaitEvent from its ProtocolBindAdapter and ProtocolUnbindAdapter functions.

Callers of NdisWaitEvent must be running at IRQL = PASSIVE_LEVEL.

See Also

DriverEntry of NDIS Protocol Drivers, MiniportHalt, MiniportInitialize, NdisInitializeEvent, NdisResetEvent, NdisSetEvent, ProtocolBindAdapter, ProtocolUnbindAdapter