IPXV_Inst::RestartTimer Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXV_Inst::RestartTimer Method}} | {{#customTitle:IPXV_Inst::RestartTimer Method}} | ||
{{#parentPage:PXV:IPXV_Inst#Methods|RestartTimer|method}} | {{#parentPage:PXV:IPXV_Inst#Methods|RestartTimer|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Restarts the specified global timer, optionally with new time-out value. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 13: | ||
== Parameters == | == Parameters == | ||
;nTimerID | ;nTimerID | ||
| − | :[in] | + | :[in] Specifies the ID of global timer. |
;nNewElapse | ;nNewElapse | ||
| − | :[in, defaultvalue(0)] | + | :[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 == | ||
Revision as of 15:42, 26 May 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.
