Edit

Share via

RtwqAddPeriodicCallback function (rtworkq.h)

  • Article

Sets a callback function to be called at a fixed interval.

Syntax

HRESULT RtwqAddPeriodicCallback(
  [in]            RTWQPERIODICCALLBACK Callback,
                  IUnknown             *context,
  [out, optional] DWORD                *key
);

Parameters

[in] Callback

Pointer to the callback function.

context

Pointer to a caller-provided object that implements IUnknown, or NULL. This parameter is passed to the callback function.

[out, optional] key

Receives a key that can be used to cancel the callback. To cancel the callback, call RtwqRemovePeriodicCallback and pass this key as the dwKey parameter.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Target Platform Windows
Header rtworkq.h
Library Rtworkq.lib
DLL RTWorkQ.dll