IPXV_Inst::StartTimer Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT StartTimer([in] IPXV_TimerHandler* | + | <pre class="brush:cpp;gutter:false">HRESULT StartTimer([in] IPXV_TimerHandler* TimerHandler, |
− | [in] ULONG | + | [in] ULONG Elapse, |
− | [in, defaultvalue(0)] ULONG | + | [in, defaultvalue(0)] ULONG Flags, |
− | [out, retval] LONG_PTR* | + | [out, retval] LONG_PTR* NewTimerID);</pre> |
== Parameters == | == Parameters == | ||
− | ; | + | ;TimerHandler |
:[in] Pointer to [[PXV:IPXV_TimerHandler|IPXV_TimerHandler]] callback. | :[in] Pointer to [[PXV:IPXV_TimerHandler|IPXV_TimerHandler]] callback. | ||
− | ; | + | ;Elapse |
:[in] The time-out value in milliseconds. | :[in] The time-out value in milliseconds. | ||
− | ; | + | ;Flags |
:[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]]. | ||
− | ; | + | ;NewTimerID |
:[out, retval] Returns the identifier of new timer. | :[out, retval] Returns the identifier of new timer. | ||
Revision as of 07:33, 12 June 2015
Starts the new custom global timer.
Syntax
HRESULT StartTimer([in] IPXV_TimerHandler* TimerHandler, [in] ULONG Elapse, [in, defaultvalue(0)] ULONG Flags, [out, retval] LONG_PTR* NewTimerID);
Parameters
- TimerHandler
- [in] Pointer to IPXV_TimerHandler callback.
- Elapse
- [in] The time-out value in milliseconds.
- Flags
- [in, defaultvalue(0)] Indicates additional flags for timer creation. See PXV_TimerFlags.
- NewTimerID
- [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