IPXV_Inst::StartTimer Method

From PDF XChange PDF SDK
Jump to: navigation, search


Starts the new custom global timer.

Syntax

HRESULT StartTimer([in]                   IPXV_TimerHandler*  pTimerHandler,
                   [in]                   ULONG               nElapse,
                   [in, defaultvalue(0)]  ULONG               nFlags,
                   [out, retval]          LONG_PTR*           nNewTimerID);

Parameters

pTimerHandler
[in] Pointer to IPXV_TimerHandler callback.
nElapse
[in] The time-out value in milliseconds.
nFlags
[in, defaultvalue(0)] Indicates additional flags for timer creation. See PXV_TimerFlags.
nNewTimerID
[out, retval] Returns the identifier of new timer.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst, IPXV_Inst::StopTimer, IPXV_Inst::StopAllTimers, IPXV_Inst::RestartTimer