SetThreadpoolWait 函式 (threadpoolapiset.h)

設定 wait 物件，並取代先前的等候物件，如果有的話。背景工作線程會在句柄收到訊號或指定的逾時到期之後呼叫等候物件的回呼函式。

語法

void SetThreadpoolWait(
  [in, out]      PTP_WAIT  pwa,
  [in, optional] HANDLE    h,
  [in, optional] PFILETIME pftTimeout
);

[in, out] pwa

定義 wait 物件的 TP_WAIT 結構的指標。 CreateThreadpoolWait 函式會傳回此指標。

[in, optional] h

控制代碼。

如果此參數為 NULL，等候物件將會停止將新的回呼排入佇列 (但已排入佇列的回呼仍會發生) 。

如果此參數不是 NULL，則必須參考有效的可等候物件。

如果等候仍在擱置時關閉此句柄，則函式的行為是未定義的。如果等候仍在擱置中，而且必須關閉句柄，請使用 CloseThreadpoolWait 取消等候，然後關閉句柄。

如果此參數為非 NULL，則會考慮設定等候。

[in, optional] pftTimeout

FILETIME 結構的指標，指定等候作業應該逾時的絕對或相對時間。如果此參數指向正值，則會以 100 奈秒間隔表示自 1601 年 1 月 1 日 (UTC) 以來的絕對時間。如果此參數指向負值，表示相對於目前時間等候的時間量。如需時間值的詳細資訊，請參閱檔案時間。

如果此參數指向 0，則等候會立即逾時。如果此參數為 NULL，等候將不會逾時。

無

wait 物件只能等候一個句柄。設定 wait 物件的句柄會取代先前的句柄，如果有的話。

每次觸發等候回呼之前，您必須先向 wait 物件重新註冊事件，再發出訊號。

若要編譯使用此函式的應用程式，請將_WIN32_WINNT定義為0x0600或更高版本。

如需範例，請參閱使用線程集區函式。

需求	值
最低支援的用戶端	Windows Vista [傳統型應用程式 \|UWP 應用程式]
最低支援的伺服器	Windows Server 2008 [傳統型應用程式 \|UWP 應用程式]
目標平台	Windows
標頭	threadpoolapiset.h (Windows 7、Windows Server 2008 Windows Server 2008 R2)
程式庫	Kernel32.lib
DLL	Kernel32.dll