IPXV_Inst::StartTimer Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::StartTimer Method}}
 
{{#customTitle:IPXV_Inst::StartTimer Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|StartTimer|method}}
 +
{{ToReview}}
  
−
The method of interface of PDF-XChange Editor SDK.
+
Starts the new custom global timer.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT StartTimer([in] IPXV_TimerHandler* pTimerHandler, [in] ULONG nElapse, [in, optional] ULONG nFlags, [out, retval] LONG_PTR* pNewTimerID);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT StartTimer([in]                   IPXV_TimerHandler* pTimerHandler,
 +
                  [in]                   ULONG               nElapse,
 +
                  [in, defaultvalue(0)] ULONG               nFlags,
 +
                  [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]  Value of ULONG.
+
:[in]  The time-out value in milliseconds.
−
;''nFlags''
+
;nFlags
−
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Indicates additional flags for timer creation. See [[PXV:PXV_TimerFlags|PXV_TimerFlags]].  
−
;''pNewTimerID''
+
;nNewTimerID
−
:[out, retval]  Pointer to LONG_PTR.
+
:[out, retval]  Returns the identifier of new timer.
  
 
== Return Value ==
 
== Return Value ==
Line 21: Line 27:
  
 
== See Also ==
 
== 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

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


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

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