> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XSystemGetConsoleId

> XSystemGetConsoleId

# XSystemGetConsoleId

傳回目前裝置的主機 ID。

## 語法

```cpp theme={null}
HRESULT XSystemGetConsoleId(  
         size_t consoleIdSize,  
         char* consoleId,  
         size_t* consoleIdUsed  
)  
```

### 參數

*consoleIdSize*   \_In\_\
類型：size\_t

*consoleId* 的大小 (以位元組為單位)。此值必須等於或大於 XSystem.h 中定義的 **XSystemConsoleIdBytes** 常數。

*consoleId*   \_Out\_writes\_bytes\_to\_(consoleIdSize,\*consoleIdUsed)\
類型：char\*

將接收主機 ID 的字元緩衝區。

*consoleIdUsed*   \_Out\_opt\_\
類型：size\_t\*

傳回之 *consoleId* 緩衝區的大小 (以位元組為單位)。

### 傳回值

類型：[HRESULT](https://learn.microsoft.com/openspecs/windows_protocols/ms-erref/0642cb2f-2075-4469-918c-4441e69c548a)

如果成功，則傳回 **S\_OK**；否則傳回錯誤碼。如需錯誤碼清單，請參閱[錯誤碼](/zh-TW/reference/errorcodes)。如果函式因 *consoleIdSize* 設定為小於 **XSystemConsoleIdBytes** 的值而失敗，傳回值會設定為 **HRESULT\_FROM\_WIN32(ERROR\_INSUFFICIENT\_BUFFER)**。

## 備註

<Note>在時間敏感執行緒上呼叫此函式並不安全。如需詳細資訊，請參閱[時間敏感執行緒](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)。</Note>

主機 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](/zh-TW/reference/system/xsystem/functions/xsystemgetappspecificdeviceid) 函式。

## 需求

**標頭：** XSystem.h

**程式庫：** xgameruntime.lib

**支援的平台：** Windows、XBOX One 系列主機和 XBOX Series 主機

## 概念文件

* [時間敏感執行緒](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## 另請參閱

[啟用您的開發套件 (NDA 主題)](/zh-TW/home/setup-install/devkits/setup/activating-dev-kit)\
[XSystemGetXboxLiveSandbodId](/zh-TW/reference/system/xsystem/functions/xsystemgetxboxlivesandboxid)\
[XSystem](/zh-TW/reference/system/xsystem/xsystem_members)


## Related topics

- [XSystemGetConsoleId](/es/reference/system/xsystem/functions/xsystemgetconsoleid.md)
- [XSystemGetXboxLiveSandboxId](/reference/system/xsystem/functions/xsystemgetxboxlivesandboxid.md)