XGameStreamingGetSessionId
此 API 會傳回以 null 結尾的不透明字串,用來唯一識別指定用戶端的串流工作階段。語法
參數
client _In_類型:XGameStreamingClientId 要查詢的串流用戶端。 sessionIdSize _In_
類型:size_t
sessionId 緩衝區的大小。
sessionId _Out_writes_bytes_to_(sessionIdSize, *sessionIdUsed)類型:char* 將填入指定用戶端之工作階段識別碼的緩衝區。 sessionIdUsed _Out_opt_
類型:size_t*
sessionId 緩衝區中所傳回值的大小 (以位元組為單位,包括 null 結束字元)。
傳回值
類型:HRESULT 如果成功,則傳回 S_OK;否則傳回錯誤碼。可能的錯誤
如需錯誤碼清單,請參閱錯誤碼。
備註
寫入sessionId 的字串永遠不會大於 SessionIdMaxBytes,因此可以預先配置。sessionId 的配置/內容日後可能會變更,因此只應將其解讀為不透明字串。如同其他用戶端屬性 API,建議使用 XGameStreamingRegisterClientPropertiesChanged 註冊回呼,以接收 sessionId 的變更。
範例
需求
標頭: xgamestreaming.h程式庫: xgameruntime.lib
支援的平台: Windows、XBOX One 系列主機和 XBOX Series 主機
