NdisWaitEvent (Compact 2013)
3/26/2014
This 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(
PNDIS_EVENT Event,
UINT MsToWait
);
Parameters
- Event
[in] Points to an initialized event object for which the caller provides the storage.
- MsToWait
[in] 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 0 specifies that the caller will wait for the event indefinitely.
Return Value
Value |
Description |
---|---|
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 given 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
Header |
ndis.h |
See Also
Reference
NDIS Event Interface
DriverEntry of NDIS Protocol Drivers
MiniportHaltEx
MiniportInitializeEx
NdisInitializeEvent
NdisResetEvent
NdisSetEvent
ProtocolBindAdapterEx
ProtocolUnbindAdapterEx