IPXV_Inst::StartTimer Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 11: | Line 11: | ||
[in] ULONG nElapse, | [in] ULONG nElapse, | ||
[in, defaultvalue(0)] ULONG nFlags, | [in, defaultvalue(0)] ULONG nFlags, | ||
| − | [out, retval] LONG_PTR* | + | [out, retval] LONG_PTR* nNewTimerID);</pre> |
== Parameters == | == Parameters == | ||
| Line 20: | Line 20: | ||
;nFlags | ;nFlags | ||
:[in, defaultvalue(0)] Indicates additional flags for timer creation. See [[PXV:PXV_TimerFlags|PXV_TimerFlags]]. | :[in, defaultvalue(0)] Indicates additional flags for timer creation. See [[PXV:PXV_TimerFlags|PXV_TimerFlags]]. | ||
| − | ; | + | ;nNewTimerID |
:[out, retval] Returns the identifier of new timer. | :[out, retval] Returns the identifier of new timer. | ||
Latest revision as of 03:58, 15 June 2015
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
