IPXV_Inst::StartTimer Method

From PDF XChange PDF SDK
Jump to: navigation, search
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*  pTimerHandler,
+
<pre class="brush:cpp;gutter:false">HRESULT StartTimer([in]                  IPXV_TimerHandler*  TimerHandler,
−
                   [in]                  ULONG              nElapse,
+
                   [in]                  ULONG              Elapse,
−
                   [in, defaultvalue(0)]  ULONG              nFlags,
+
                   [in, defaultvalue(0)]  ULONG              Flags,
−
                   [out, retval]          LONG_PTR*          nNewTimerID);</pre>
+
                   [out, retval]          LONG_PTR*          NewTimerID);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;pTimerHandler
+
;TimerHandler
 
:[in]  Pointer to [[PXV:IPXV_TimerHandler|IPXV_TimerHandler]] callback.
 
:[in]  Pointer to [[PXV:IPXV_TimerHandler|IPXV_TimerHandler]] callback.
−
;nElapse
+
;Elapse
 
:[in]  The time-out value in milliseconds.
 
:[in]  The time-out value in milliseconds.
−
;nFlags
+
;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]].  
−
;nNewTimerID
+
;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

PDF Editor Layer > Interfaces > IPXV_Inst > IPXV_Inst::StartTimer Method


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

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXV_Inst_StartTimer&oldid=43496"