Skip to content

Update Timer.xml #8456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tohoit02 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Timer.xml #8456

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ffbc3d
Update Timer.xml
tohoit02 Oct 4, 2022
c076299
Merge branch 'main' into tohoit02-Timer-in-ticks
tohoit02 Mar 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions xml/System.Threading/Timer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -857,15 +857,17 @@ Sub TimerCallback(state As Object)
<returns>
<see langword="true" /> if the timer was successfully updated; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The callback method is invoked once after `dueTime` elapses, and thereafter each time the time interval specified by `period` elapses.

If `dueTime` is <xref:System.TimeSpan.Zero?displayProperty=nameWithType>, the callback method is invoked immediately. If `dueTime` is <xref: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`.

If `period` is <xref:System.TimeSpan.Zero?displayProperty=nameWithType> or <xref: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`.

<format type="text/markdown"><![CDATA[

## Remarks
The callback method is invoked once after `dueTime` elapses, and thereafter each time the time interval specified by `period` elapses.

If `period` value is provided in ticks, they have to be greater or equal to 1 millisecond. A tick value below 1 millisecond will be rounded down to zero (0).

If `dueTime` is <xref:System.TimeSpan.Zero?displayProperty=nameWithType>, the callback method is invoked immediately. If `dueTime` is <xref: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`.

If `period` is <xref:System.TimeSpan.Zero?displayProperty=nameWithType> or <xref: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`.

The <xref:System.Threading.Timer.Change%2A> method can be called from the <xref:System.Threading.TimerCallback> delegate.

## Examples
Expand Down