Edit

IMFTimer::CancelTimer method (mfidl.h)

  • Article

Cancels a timer that was set using the IMFTimer::SetTimer method.

Syntax

HRESULT CancelTimer(
  [in] IUnknown *punkKey
);

Parameters

[in] punkKey

Pointer to the IUnknown interface that was returned in the ppunkKey parameter of the SetTimer method.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.

Remarks

Because the timer is dispatched asynchronously, the application's timer callback might get invoked even if this method succeeds.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mfidl.h
Library Mfuuid.lib

See also

IMFTimer