IPXV_Inst::RestartTimer Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::RestartTimer Method}}
 
{{#customTitle:IPXV_Inst::RestartTimer Method}}
{{#parentPage:PXV:IPXV_Inst|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|RestartTimer|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Restarts the specified global timer, optionally with new time-out value.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT RestartTimer([in] LONG_PTR nTimerID, [in, defaultvalue(0)] ULONG nNewElapse);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT RestartTimer([in]                   LONG_PTR nTimerID,
 +
                    [in, defaultvalue(0)] ULONG     nNewElapse);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nTimerID''
+
;nTimerID
:[in]  Value of LONG_PTR.
+
:[in]  Specifies the ID of global timer.
;''nNewElapse''
+
;nNewElapse
:[in, defaultvalue(0)]  Value of ULONG.
+
:[in, defaultvalue(0)]  Pass new non-zero time-out value, in milliseconds, to replace current, or pass '''0''' to keep unchanged the current value.
  
 
== Return Value ==
 
== Return Value ==
Line 20: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_StartTimer|IPXV_Inst::StartTimer]]

Latest revision as of 03:57, 15 June 2015


Restarts the specified global timer, optionally with new time-out value.

Syntax

HRESULT RestartTimer([in]                   LONG_PTR  nTimerID,
                     [in, defaultvalue(0)]  ULONG     nNewElapse);

Parameters

nTimerID
[in] Specifies the ID of global timer.
nNewElapse
[in, defaultvalue(0)] Pass new non-zero time-out value, in milliseconds, to replace current, or pass 0 to keep unchanged the current value.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst, IPXV_Inst::StartTimer