Edit

Share via

StreamClassScheduleTimer function (strmini.h)

  • Article

The minidriver calls the StreamClassScheduleTimer routine to schedule a timer, and to specify a routine that is called when the timer expires.

Syntax

VOID STREAMAPI StreamClassScheduleTimer(
  [in, optional] PHW_STREAM_OBJECT StreamObject,
  [in]           PVOID             HwDeviceExtension,
  [in]           ULONG             NumberOfMicroseconds,
  [in]           PHW_TIMER_ROUTINE TimerRoutine,
  [in]           PVOID             Context
);

Parameters

[in, optional] StreamObject

Specifies the stream that sets the timer, or NULL if the timer is set for the whole driver. The minidriver may only schedule one timer per stream, and one for the driver as a whole. This parameter is optional.

[in] HwDeviceExtension

Pointer to the minidriver's device extension. The minidriver specifies the size of this buffer in the HW_INITIALIZATION_DATA structure it passes when it registers itself via StreamClassRegisterMinidriver. The class driver then passes pointers to the buffer in the HwDeviceExtension member of the HW_STREAM_REQUEST_BLOCK, HW_STREAM_OBJECT, HW_TIME_CONTEXT, and PORT_CONFIGURATION_INFORMATION structures it passes to the minidriver.

[in] NumberOfMicroseconds

Specifies the amount of time, in microseconds, before the timer expires.

[in] TimerRoutine

Specifies the routine called when the timer expires. The routine's prototype must be of the form:

TimerRoutine(PVOID Context);

[in] Context

Pointer to a context that the class driver passes to the callback routine once the timer expires.

Return value

None

Requirements

Requirement Value
Target Platform Desktop
Header strmini.h (include Strmini.h)
Library Stream.lib