NdisWaitEvent function

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

Syntax


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

Parameters

Event [in]

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

MsToWait [in]

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.

Remarks

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 MiniportInitializeEx and MiniportHaltEx functions. A protocol driver typically calls NdisWaitEvent from its ProtocolBindAdapterEx and ProtocolUnbindAdapterEx functions.

Requirements

Version

Supported for NDIS 6.0 and NDIS 5.1 drivers (see NdisWaitEvent (NDIS 5.1)) in Windows Vista. Supported for NDIS 5.1 drivers (see NdisWaitEvent (NDIS 5.1)) in Windows XP.

Header

Ndis.h (include Ndis.h)

IRQL

PASSIVE_LEVEL

DDI compliance rules

Irql_Miscellaneous_Function

See also

DriverEntry of NDIS Protocol Drivers
MiniportHaltEx
MiniportInitializeEx
NdisInitializeEvent
NdisResetEvent
NdisSetEvent
ProtocolBindAdapterEx
ProtocolUnbindAdapterEx

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft