NdisInitializeTimer
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This function initializes a timer object associated with a driver's timer function.
Syntax
VOID NdisInitializeTimer(
PNDIS_TIMER Timer,
PNDIS_TIMER_FUNCTION TimerFunction,
PVOID FunctionContext
);
Parameters
- Timer
[in] Points to caller-supplied, resident storage that receives a timer object.
- TimerFunction
[in] Specifies the entry point of a caller-supplied timer function that is called when the timer expires.
- FunctionContext
[in] Points to a caller-supplied context to be passed to the specified timer function when it is called.
Return Value
None.
Remarks
A protocol driver might request that NDIS provide timing services. To request timing services, this protocol driver calls NdisInitializeTimer to set up the driver's timer function. Typically, NdisInitializeTimer is called when a driver initializes. The protocol driver must call NdisInitializeTimer with a caller-supplied pointer to store a timer object, thereby associating a driver-supplied timer function with the timer object. The protocol driver must call NdisInitializeTimer before the driver passes the Timer pointer to any other NdisXXXTimer function.
Calls to the NdisSetTimer function insert the timer object in the system timer queue. Calls to NdisCancelTimer dequeue the timer object if it is currently queued. Only one instance of a particular timer object can be queued at any given moment.
After a driver calls NdisSetTimer, the timer object at Timer is queued until the interval specified in the call expires.
Requirements
| Header | ndis.h |
| Library | ndis.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |