XTaskQueueTerminate
藉由取消所有擱置中的項目並防止新項目加入佇列,來終止工作佇列。語法
參數
queue _In_類型:XTaskQueueHandle 要終止的佇列。 wait _In_
類型:bool True 表示等候終止完成。 callbackContext _In_opt_
類型:void* 要傳遞給回呼的選擇性內容指標。 callback _In_opt_
類型:XTaskQueueTerminatedCallback* 佇列終止時將呼叫的選擇性回呼。
傳回值
類型:HRESULT HRESULT 成功或錯誤碼。備註
在時間敏感執行緒上呼叫此函式並不安全。如需詳細資訊,請參閱時間敏感執行緒。
- 兩個連接埠的所有回呼都會在 canceled 參數設定為 true 的情況下被叫用。
- 工作連接埠上所有擱置中的回呼都會被分派。將新的回呼提交至工作連接埠將會失敗並傳回 E_ABORT。
- 完成連接埠上所有擱置中的回呼都會被分派。將新的回呼提交至完成連接埠將會失敗並傳回 E_ABORT。
- XTaskQueueTerminate 不會關閉佇列控制代碼。終止之後,您仍然需要呼叫 XTaskQueueCloseHandle。
- 如果您在透過呼叫 XTaskQueueDispatch 處理佇列回呼的執行緒上呼叫 XTaskQueueTerminate,請勿為 wait 參數傳遞 true,否則您的程式碼可能會發生死結。
SubmitCallback 是在 XTaskQueueSubmitCallback 函式的程式碼範例中定義的協助程式函式。
需求
標頭: XTaskQueue.h 程式庫: xgameruntime.lib 支援的平台: Windows、XBOX One 系列主機和 XBOX Series 主機概念文件
另請參閱
XTaskQueue 成員非同步程式設計模型
非同步工作佇列設計
