IPXV_Inst::StartTimer Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 6: | Line 6: | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Starts the custom global timer. | |
== Syntax == | == Syntax == | ||
| Line 16: | Line 16: | ||
== 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)] Pass <tt>0</tt> here. |
;pNewTimerID | ;pNewTimerID | ||
| − | :[out, retval] | + | :[out, retval] Returns the identifier of new timer. |
== Return Value == | == Return Value == | ||
Revision as of 18:52, 26 May 2015
Starts the custom global timer.
Syntax
HRESULT StartTimer([in] IPXV_TimerHandler* pTimerHandler,
[in] ULONG nElapse,
[in, defaultvalue(0)] ULONG nFlags,
[out, retval] LONG_PTR* pNewTimerID);
Parameters
- pTimerHandler
- [in] Pointer to IPXV_TimerHandler callback.
- nElapse
- [in] The time-out value in milliseconds.
- nFlags
- [in, defaultvalue(0)] Pass 0 here.
- pNewTimerID
- [out, retval] Returns the identifier of new timer.
Return Value
Returns S_OK if operation was successful or error code in other cases.
