IPXV_Inst::RestartTimer Method

Latest revision as of 02:57, 15 June 2015

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

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

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

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.

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IPXV_Inst::RestartTimer Method}}
+{{#parentPage:PXV:IPXV_Inst#Methods|RestartTimer|method}}
+{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Restarts the specified global timer, optionally with new time-out value.
 == 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 ==
-;''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 ==
@@ Line 17: / Line 21: @@
 == See Also ==
-See also [[PXV:IPXV_Inst|IPXV_Inst]].
+[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_StartTimer|IPXV_Inst::StartTimer]]