IPXV_Inst::StartTimer Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::StartTimer Method}} | {{#customTitle:IPXV_Inst::StartTimer Method}} | ||
| − | {{#parentPage:PXV:IPXV_Inst|StartTimer | + | {{#parentPage:PXV:IPXV_Inst#Methods|StartTimer|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Starts the new custom global timer. | |
== Syntax == | == Syntax == | ||
| Line 12: | 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 == | ||
;pTimerHandler | ;pTimerHandler | ||
| − | :[in] Pointer to [[PXV:IPXV_TimerHandler|IPXV_TimerHandler]]. | + | :[in] Pointer to [[PXV:IPXV_TimerHandler|IPXV_TimerHandler]] callback. |
;nElapse | ;nElapse | ||
| − | :[in] | + | :[in] The time-out value in milliseconds. |
;nFlags | ;nFlags | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Indicates additional flags for timer creation. See [[PXV:PXV_TimerFlags|PXV_TimerFlags]]. |
| − | ; | + | ;nNewTimerID |
| − | :[out, retval] | + | :[out, retval] Returns the identifier of new timer. |
== Return Value == | == Return Value == | ||
| Line 28: | Line 27: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXV_Inst|IPXV_Inst]] | + | [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_StopTimer|IPXV_Inst::StopTimer]], [[PXV:IPXV_Inst_StopAllTimers|IPXV_Inst::StopAllTimers]], [[PXV:IPXV_Inst_RestartTimer|IPXV_Inst::RestartTimer]] |
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
