You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update Timer.xml for consistency
int and long use the terms milliseconds and values (0) or (-1) where as `TimeSpan` overload reference `System.TimeSpan.Zero` or `Timeout.Infinite`.
* Update Timer.xml
Fixed a few typos
* Update Timer.xml
Fixed a few typos
* Update Timer.xml
Ooops
* Update Timer.xml
few more places I missed
* Update Timer.xml
oops
* Update Timer.xml
oops
* Update Timer.xml
double wording
* Update Timer.xml
Reverted 247-248.
Other suggestions hopefully done correctly this time.
* Update Timer.xml
Yea I saw ghost :p
* Update Timer.xml
Never saw the sequel https://www.imdb.com/title/tt2623408/
* Update Timer.xml
Could I waste any more of his time...
Copy file name to clipboardExpand all lines: xml/System.Threading/Timer.xml
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -386,8 +386,8 @@ Sub TimerCallback(state As Object)
386
386
<Docs>
387
387
<paramname="callback">A delegate representing a method to be executed.</param>
388
388
<paramname="state">An object containing information to be used by the callback method, or <seelangword="null" />.</param>
389
-
<paramname="dueTime">The amount of time to delay before the <paramrefname="callback" /> parameter invokes its methods. Specify negative one (-1) milliseconds to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param>
390
-
<paramname="period">The time interval between invocations of the methods referenced by <paramrefname="callback" />. Specify negative one (-1) milliseconds to disable periodic signaling.</param>
389
+
<paramname="dueTime">The amount of time to delay before the <paramrefname="callback" /> is invoked. Specify <seecref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to prevent the timer from starting. Specify <seecref="F:System.TimeSpan.Zero" /> to start the timer immediately.</param>
390
+
<paramname="period">The time interval between invocations of <paramrefname="callback" />. Specify <seecref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable periodic signaling.</param>
391
391
<summary>Initializes a new instance of the <seelangword="Timer" /> class, using <seecref="T:System.TimeSpan" /> values to measure time intervals.</summary>
392
392
<remarks>
393
393
<formattype="text/markdown"><![CDATA[
@@ -716,8 +716,8 @@ Sub TimerCallback(state As Object)
716
716
<ParameterName="period"Type="System.TimeSpan" />
717
717
</Parameters>
718
718
<Docs>
719
-
<paramname="dueTime">A <seecref="T:System.TimeSpan" /> representing the amount of time to delay before invoking the callback method specified when the <seecref="T:System.Threading.Timer" /> was constructed. Specify negative one (-1) milliseconds to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param>
720
-
<paramname="period">The time interval between invocations of the callback method specified when the <seecref="T:System.Threading.Timer" /> was constructed. Specify negative one (-1) milliseconds to disable periodic signaling.</param>
719
+
<paramname="dueTime">A <seecref="T:System.TimeSpan" /> representing the amount of time to delay before invoking the callback method specified when the <seecref="T:System.Threading.Timer" /> was constructed. Specify <seecref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to prevent the timer from restarting. Specify <seecref="F:System.TimeSpan.Zero" /> to restart the timer immediately.</param>
720
+
<paramname="period">The time interval between invocations of the callback method specified when the <seecref="T:System.Threading.Timer" /> was constructed. Specify <seecref="F:System.Threading.Timeout.InfiniteTimeSpan" /> to disable periodic signaling.</param>
721
721
<summary>Changes the start time and the interval between method invocations for a timer, using <seecref="T:System.TimeSpan" /> values to measure time intervals.</summary>
722
722
<returns>
723
723
<seelangword="true" /> if the timer was successfully updated; otherwise, <seelangword="false" />.</returns>
@@ -727,9 +727,9 @@ Sub TimerCallback(state As Object)
727
727
## Remarks
728
728
The callback method is invoked once after `dueTime` elapses, and thereafter each time the time interval specified by `period` elapses.
729
729
730
-
If `dueTime` is zero (0), the callback method is invoked immediately. If `dueTime` is negative one (-1) milliseconds, the callback method is never invoked; the timer is disabled, but can be re-enabled by calling <xref:System.Threading.Timer.Change%2A> and specifying a positive value for `dueTime`.
730
+
If `dueTime` is <xref cref="F:System.TimeSpan.Zero?displayProperty=nameWithType" />, the callback method is invoked immediately. If `dueTime` is <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" />, the callback method is never invoked; the timer is disabled, but can be re-enabled by calling <xref:System.Threading.Timer.Change%2A> and specifying a positive value for `dueTime`.
731
731
732
-
If `period` is zero (0) or negative one (-1) milliseconds, and `dueTime` is positive, the callback method is invoked once; the periodic behavior of the timer is disabled, but can be re-enabled by calling <xref:System.Threading.Timer.Change%2A> and specifying a value greater than zero for `period`.
732
+
If `period` is <xref cref="F:System.TimeSpan.Zero?displayProperty=nameWithType" /> or <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" />, and `dueTime` is positive, the callback method is invoked once; the periodic behavior of the timer is disabled, but can be re-enabled by calling <xref:System.Threading.Timer.Change%2A> and specifying a value greater than zero for `period`.
733
733
734
734
The <xref:System.Threading.Timer.Change%2A> method can be called from the <xref:System.Threading.TimerCallback> delegate.
0 commit comments