GetUmsCompletionListEvent 関数 (winbase.h)

指定したユーザー モード スケジューリング (UMS) 完了リストに関連付けられているイベントへのハンドルを取得します。

構文

BOOL GetUmsCompletionListEvent(
  [in]      PUMS_COMPLETION_LIST UmsCompletionList,
  [in, out] PHANDLE              UmsCompletionEvent
);

パラメーター

[in] UmsCompletionList

UMS 入力候補リストへのポインター。 CreateUmsCompletionList 関数は、このポインターを提供します。

[in, out] UmsCompletionEvent

HANDLE 変数へのポインター。 出力時に、 UmsCompletionEvent パラメーターは、指定した完了リストに関連付けられているイベントのハンドルに設定されます。

戻り値

関数が成功すると、0 以外の値が返されます。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

システムは、空の完了リストに項目をキューに入れると、UMS 完了リスト イベントを通知します。 完了リストのイベント ハンドルは、イベントにハンドルを受け取る 待機関数 と共に使用できます。 イベントが通知されると、通常、アプリケーションは DequeueUmsCompletionListItems を呼び出して完了リストの内容を取得します。

イベント ハンドルは、完了リストが削除されるまで有効なままです。 イベント ハンドルを使用して、削除された、または削除中の完了リストを待機しないでください。

ハンドルが不要になったら、 CloseHandle 関数を使用してハンドルを閉じます。

要件

こちらもご覧ください

CreateUmsCompletionList

DequeueUmsCompletionListItems

待機関数