ThreadPoolTimer.Period property

Applies to Windows and Windows Phone

Gets the timeout value of a periodic timer created with CreatePeriodicTimer.

Syntax


public TimeSpan Period { get; }

Property value

Type: System.TimeSpan [.NET] | Windows::Foundation::TimeSpan [C++]

The timeout value. When the timeout value elapses, the timer expires, its TimerElapsedHandler delegate is called, and the timer reactivates. This behavior continues until the timer is canceled.

C++:  This amount of time is specified in ticks (100-nanosecond units) using the Windows::Foundation::TimeSpan structure.

JavaScript and C#:  This amount of time is specified using the System.TimeSpan structure. It can be specified in ticks, or it can be specified in milliseconds, seconds, and so on.

Note  If this property is set to zero (or any value less than 1 millisecond) the periodic timer behaves as a single-shot timer.

Remarks

A periodic timer begins counting down as soon as the timer object is created. When the timer expires, it is reactivated and begins counting down again.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8

Namespace

Windows.System.Threading
Windows::System::Threading [C++]

Metadata

Windows.winmd

See also

ThreadPoolTimer

 

 

Show:
© 2014 Microsoft. All rights reserved.