dotnet / dotnet/dotnet-api-docs

Undocumented boolean returned by PeriodicTimer.WaitForNextTick?

Open
#10,407 3 comments 0 reactions 0 assignees View on GitHub
area-System.Threading.Tasks Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

### Type of issue

Missing information

### Description

Greetings.

I don't have much time to look more in details but it seems to me that the boolean value returned by `WaitForNextTick` is not clearly documented. Three possible events are mentioned:

- timer firing
- `Dispose()` call
- task cancellation

But the boolean value's meaning in relation to this isn't explicitly described. My guess would be that it is `true` if the timer fired and `false` in any other case?... But, well, that's a guess! :)

### Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.threading.periodictimer.waitfornexttickasync?view=net-8.0#system-threading-periodictimer-waitfornexttickasync(system-threading-cancellationtoken)

### Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Threading/PeriodicTimer.xml

### Document Version Independent Id

0ef31de4-0c6b-4ae5-b172-c2e89beee4cc

### Article author

@dotnet-bot

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.