ThreadPoolTimer クラス

定義

名前空間:

Windows.System.Threading

CreateTimer または CreatePeriodicTimer で作成されたタイマーを表します。

注意

ThreadPool API は、デスクトップアプリと UWP アプリでサポートされています。

public ref class ThreadPoolTimer sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ThreadPoolTimer final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ThreadPoolTimer

Public NotInheritable Class ThreadPoolTimer

継承

Object Platform::Object IInspectable ThreadPoolTimer

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

次のコードは、 TimerElapsedHandler デリゲート メソッドを渡すことによって定期的なタイマーを作成する方法を示しています。

int period = 1000;

ThreadPoolTimer PeriodicTimer =
    ThreadPoolTimer.CreatePeriodicTimer(ExampleTimerElapsedHandler,
                                        TimeSpan.FromMilliseconds(period));

タイマーを使用してアプリが完了したら、それを取り消す必要があります。 次のコードは、前の例で作成した定期的なタイマーを取り消します。

if (PeriodicTimer != null)
{
    PeriodicTimer.Cancel();
}

注釈

CreatePeriodicTimer メソッドまたは CreateTimer メソッドを使用して、このオブジェクトを作成できます。

注意

TimeSpan 値が 0 (または 1 ミリ秒未満の値) の場合、定期的なタイマーはシングルショット タイマーとして動作します。

プロパティ

Delay	CreateTimer で作成された単一使用タイマーのタイムアウト値を取得します。
Period	CreatePeriodicTimer で作成された定期的なタイマーのタイムアウト値を取得します。

メソッド

Cancel()	タイマーを取り消します。
CreatePeriodicTimer(TimerElapsedHandler, TimeSpan)	定期的なタイマーを作成します。
CreatePeriodicTimer(TimerElapsedHandler, TimeSpan, TimerDestroyedHandler)	定期的なタイマーを作成し、定期的なタイマーが完了した後に呼び出すメソッドを指定します。 タイマーが再アクティブ化されずに期限切れになり、ハンドラーの最後の呼び出しが完了すると、定期的な タイマー が完了します。
CreateTimer(TimerElapsedHandler, TimeSpan)	シングルユース タイマーを作成します。
CreateTimer(TimerElapsedHandler, TimeSpan, TimerDestroyedHandler)	シングルユース タイマーを作成し、タイマーの完了後に呼び出すメソッドを指定します。 タイマーの有効期限が切れ、 ハンドラー の最後の呼び出しが完了すると、タイマーは完了します。