PFNKSCANCELTIMER callback function (ks.h)

A streaming minidriver's KStrCancelTimer routine is called to cancel a custom timer object that was previously specified in the SetTimer parameter in a call to KsAllocateDefaultClockEx.

Syntax

PFNKSCANCELTIMER Pfnkscanceltimer;

BOOLEAN Pfnkscanceltimer(
  [in] PVOID Context,
  [in] PKTIMER Timer
)
{...}

Parameters

[in] Context

Pointer to the minidriver-supplied information context. The minidriver passes the information context to KsAllocateDefaultClockEx in the function's DeferredContext parameter when the minidriver allocates a custom DPC timer object.

[in] Timer

Pointer to the minidriver's custom timer object to cancel.

Return value

Returns TRUE if the specified timer object is in the system timer queue, or FALSE otherwise.

Remarks

Minidrivers can optionally supply a KStrCancelTimer callback function as a parameter to KsAllocateDefaultClockEx.

The minidriver-supplied KStrCancelTimer must have the same characteristics as KeCancelTimer.

If a minidriver supplies a KStrCancelTimer callback function, the minidriver must also supply a KStrSetTimer callback function.

Requirements

See also

KStrSetTimer

KeCancelTimer

KsAllocateDefaultClockEx