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)
 
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT RestartTimer([in]                  LONG_PTR  TimerID,
+
<pre class="brush:cpp;gutter:false">HRESULT RestartTimer([in]                  LONG_PTR  nTimerID,
                     [in, defaultvalue(0)]  ULONG    NewElapse);</pre>
+
                     [in, defaultvalue(0)]  ULONG    nNewElapse);</pre>
  
 
== Parameters ==
 
== Parameters ==
;TimerID
+
;nTimerID
 
:[in]  Specifies the ID of global timer.
 
:[in]  Specifies the ID of global timer.
;NewElapse
+
;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.
 
:[in, defaultvalue(0)]  Pass new non-zero time-out value, in milliseconds, to replace current, or pass '''0''' to keep unchanged the current value.
  

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