CreateWaitableTimerW 関数 (synchapi.h)
待機可能なタイマー オブジェクトを作成または開きます。
オブジェクトのアクセス マスクを指定するには、 CreateWaitableTimerEx 関数を 使用します。
構文
HANDLE CreateWaitableTimerW(
[in, optional] LPSECURITY_ATTRIBUTES lpTimerAttributes,
[in] BOOL bManualReset,
[in, optional] LPCWSTR lpTimerName
);
パラメーター
[in, optional] lpTimerAttributes
新しいタイマー オブジェクトのセキュリティ 記述子を指定し、子プロセスが返されたハンドルを継承できるかどうかを判断するSECURITY_ATTRIBUTES構造体へのポインター。
lpTimerAttributes が NULL の場合、タイマー オブジェクトは既定のセキュリティ記述子を取得し、ハンドルを継承できません。 タイマーの既定のセキュリティ記述子の ACL は、作成者のプライマリ トークンまたは偽装トークンから取得されます。
[in] bManualReset
このパラメーターが TRUE の場合、タイマーは手動リセット通知タイマーです。 それ以外の場合、タイマーは同期タイマーです。
[in, optional] lpTimerName
タイマー オブジェクトの名前。 名前は MAX_PATH 文字に制限されます。 名前の比較では大文字と小文字が区別されます。
lpTimerName が NULL の場合、タイマー オブジェクトは名前なしで作成されます。
lpTimerName が既存のイベント、セマフォ、ミューテックス、ジョブ、またはファイル マッピング オブジェクトの名前と一致する場合、関数は失敗し、GetLastError はERROR_INVALID_HANDLEを返します。 これは、これらのオブジェクトが同じ名前空間を共有しているために発生します。
名前には、グローバル名前空間またはセッション名前空間にオブジェクトを明示的に作成するための "Global" または "Local" プレフィックスを付けることができます。 名前の残りの部分には、円記号 (\) を除く任意の文字を含めることができます。 詳細については、「 カーネル オブジェクトの名前空間」を参照してください。 高速ユーザー切り替えは、ターミナル サービス セッションを使用して実装されます。 カーネル オブジェクト名は、アプリケーションが複数のユーザーをサポートできるように、ターミナル サービスに関して説明されているガイドラインに従う必要があります。
オブジェクトはプライベート名前空間に作成できます。 詳細については、「 オブジェクト名前空間」を参照してください。
戻り値
関数が成功した場合、戻り値はタイマー オブジェクトへのハンドルです。 関数呼び出しの前に名前付きタイマー オブジェクトが存在する場合、関数は既存のオブジェクトへのハンドルを返し、GetLastError はERROR_ALREADY_EXISTSを返します。
関数が失敗した場合は、返される値は NULL です。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
CreateWaitableTimer によって返されるハンドルは、TIMER_ALL_ACCESSアクセス権を使用して作成されます。呼び出し元にアクセス権が付与されていれば、タイマー オブジェクトへのハンドルを必要とする任意の関数で使用できます。 タイマーが別のユーザーを偽装しているサービスまたはスレッドから作成された場合は、タイマーの作成時にセキュリティ記述子をタイマーに適用するか、既定の DACL を変更して作成プロセスの既定のセキュリティ記述子を変更できます。 詳細については、「 同期オブジェクトのセキュリティとアクセス権」を参照してください。
呼び出し元プロセスのすべてのスレッドは、 待機関数の 1 つの呼び出しでタイマー オブジェクト ハンドルを指定できます。
複数のプロセスで同じタイマー オブジェクトへのハンドルを持つことができます。これにより、プロセス間同期に オブジェクトを使用できます。
- CreateWaitableTimer の lpTimerAttributes パラメーターで継承が有効な場合、CreateProcess 関数によって作成されたプロセスはタイマー オブジェクトへのハンドルを継承できます。
- プロセスでは、 DuplicateHandle 関数の呼び出しでタイマー オブジェクト ハンドルを指定できます。 結果のハンドルは、別のプロセスで使用できます。
- プロセスでは、 OpenWaitableTimer 関数または CreateWaitableTimer 関数の呼び出しでタイマー オブジェクトの名前 を 指定できます。
この関数を使用するアプリケーションをコンパイルするには、 _WIN32_WINNT を 0x0400 以降として定義します。 詳細については、「 Windows ヘッダーの使用」を参照してください。
タイマーをウィンドウに関連付けるには、 SetTimer 関数を使用します。
例
CreateWaitableTimer を使用する例については、「待機可能タイマー オブジェクトの使用」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | synchapi.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |
関連項目
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示