NDIS_TIMER_CHARACTERISTICS structure (ndis.h)

The NDIS_TIMER_CHARACTERISTICS structure defines characteristics of a one-shot or periodic timer.

Syntax

typedef struct _NDIS_TIMER_CHARACTERISTICS {
  NDIS_OBJECT_HEADER   Header;
  ULONG                AllocationTag;
  PNDIS_TIMER_FUNCTION TimerFunction;
  PVOID                FunctionContext;
} NDIS_TIMER_CHARACTERISTICS, *PNDIS_TIMER_CHARACTERISTICS;

Members

Header

The NDIS_OBJECT_HEADER structure for the NDIS_TIMER_CHARACTERISTICS structure. Set the Type member of the structure that Header specifies to NDIS_OBJECT_TYPE_TIMER_CHARACTERISTICS, the Revision member to NDIS_TIMER_CHARACTERISTICS_REVISION_1, and the Size member to NDIS_SIZEOF_TIMER_CHARACTERISTICS_REVISION_1.

AllocationTag

A string that is delimited by single quotation marks and contains up to four characters, usually specified in reversed order. You must provide this tag. NDIS uses this tag when it allocates memory for the timer.

TimerFunction

A pointer to an entry point for a NetTimerCallback function. NDIS calls this function when a timer fires.

FunctionContext

A pointer to a driver-allocated context area. NDIS passes this pointer to the NetTimerCallback function when a timer fires.

Remarks

To allocate and initialize a timer object, NDIS drivers call the NdisAllocateTimerObject function and provide an NDIS_TIMER_CHARACTERISTICS structure. The timer does not start until the driver calls the NdisSetTimerObject function.

Requirements

See also

NDIS_OBJECT_HEADER

NdisAllocateTimerObject

NdisSetTimerObject

NetTimerCallback