Skip to main content

​
XSystemGetConsoleId

傳回目前裝置的主機 ID。

​
語法

​
參數

consoleIdSize   _In_
類型：size_t consoleId 的大小 (以位元組為單位)。此值必須等於或大於 XSystem.h 中定義的 XSystemConsoleIdBytes 常數。 consoleId   _Out_writes_bytes_to_(consoleIdSize,*consoleIdUsed)
類型：char* 將接收主機 ID 的字元緩衝區。 consoleIdUsed   _Out_opt_
類型：size_t* 傳回之 consoleId 緩衝區的大小 (以位元組為單位)。

​
傳回值

類型：HRESULT 如果成功，則傳回 S_OK；否則傳回錯誤碼。如需錯誤碼清單，請參閱錯誤碼。如果函式因 consoleIdSize 設定為小於 XSystemConsoleIdBytes 的值而失敗，傳回值會設定為 HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)。

​
備註

在時間敏感執行緒上呼叫此函式並不安全。如需詳細資訊，請參閱時間敏感執行緒。
主機 ID 僅在開發案例中為 XBOX Live 唯一識別 XBOX 裝置。主機 ID 用於識別主機以進行記錄和管理；例如，擷取分析資訊，或判斷在開發環境中要重新開機哪一部開發套件。此函式傳回的 ID 與 [設定] \ [系統] \ [主機資訊] 中可檢視的主機 ID 相符。 對於 XBOX 裝置，主機 ID 儲存在裝置上。如果找不到主機 ID，或您沒有存取主機 ID 的權限，則主機 ID 預設為 00000000.00000000.00000000.00000000.00。對於 PC 裝置，主機 ID 一律預設為 00000000.00000000.00000000.00000000.00。 在零售環境中，此函式一律會傳回 00000000.00000000.00000000.00000000.00。如果遊戲需要可在包括零售在內的所有情況下使用的識別碼， 有兩種可能的做法：
  • 如果您的應用程式使用單一登入 (SSO)，您應該使用 XSTS SSO 權杖的成對 ID，而不是此函式傳回的 ID。
  • 否則，請使用 XSystemGetAppSpecificDeviceId 函式。

​
需求

標頭： XSystem.h 程式庫： xgameruntime.lib 支援的平台： Windows、XBOX One 系列主機和 XBOX Series 主機

​
概念文件

​
另請參閱

啟用您的開發套件 (NDA 主題)
XSystemGetXboxLiveSandbodId
XSystem
Last modified on October 6, 2026