RxCancelTimerRequest function (rxtimer.h)

RxCancelTimerRequest cancels a recurrent timer request. The request to be canceled is identified by the worker thread routine and associated context.

Syntax

NTSTATUS RxCancelTimerRequest(
  [in] IN PRDBSS_DEVICE_OBJECT     pDeviceObject,
  [in] IN PRX_WORKERTHREAD_ROUTINE Routine,
  [in] IN PVOID                    pContext
);

Parameters

[in] pDeviceObject

A pointer to the device object that initialized the timer. This parameter was passed to the RxPostRecurrentTimerRequest routine when this recurrent timer was initialized.

[in] Routine

A pointer to the worker thread routine to call when this timer expires. This parameter was passed to the RxPostRecurrentTimerRequest routine when this recurrent timer was initialized.

[in] pContext

A pointer to the context parameter that was passed to the RxPostRecurrentTimerRequest routine when this timer was initialized.

Return value

RxCancelTimerRequest returns STATUS_SUCCESS on success.

Remarks

A recurrent timer is initialized by calling RxPostRecurrentTimerRequest.

If the recurrent timer is not found, this routine will return STATUS_NOT_FOUND.

Requirements

Requirement Value
Target Platform Desktop
Header rxtimer.h (include Rxtimer.h, Rxworkq.h)
IRQL <= APC_LEVEL

See also

RxPostOneShotTimerRequest

RxPostRecurrentTimerRequest