IPXV_Inst::StartTimer Method
From PDF XChange PDF SDK
Line 20: | Line 20: | ||
:[in] The time-out value in milliseconds. | :[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]]. |
;pNewTimerID | ;pNewTimerID | ||
:[out, retval] Returns the identifier of new timer. | :[out, retval] Returns the identifier of new timer. |
Revision as of 18:55, 26 May 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* pNewTimerID);
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.
- pNewTimerID
- [out, retval] Returns the identifier of new timer.
Return Value
Returns S_OK if operation was successful or error code in other cases.