> ## 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 を返します。

## Syntax

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

### Parameters

*consoleIdSize*   \_In\_\
型: size\_t

*consoleId* のサイズ (バイト単位)。この値は、XSystem.h で定義されている **XSystemConsoleIdBytes** 定数以上である必要があります。

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

本体 ID を受け取る文字バッファー。

*consoleIdUsed*   \_Out\_opt\_\
型: size\_t\*

返される *consoleId* バッファーのサイズ (バイト単位)。

### Return value

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

成功した場合は **S\_OK**、それ以外の場合はエラー コードを返します。エラー コードの一覧については、[エラー コード](/reference/errorcodes) を参照してください。*consoleIdSize* が **XSystemConsoleIdBytes** より小さい値に設定されているために関数が失敗した場合、戻り値は **HRESULT\_FROM\_WIN32(ERROR\_INSUFFICIENT\_BUFFER)** に設定されます。

## Remarks

<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` が既定値になります。

RETAIL では、この関数は常に `00000000.00000000.00000000.00000000.00` を返します。ゲームで小売環境を含むすべての状況で使用できる識別子が必要な場合、以下の 2 つの選択肢があります:

* アプリケーションでシングル サインオン (SSO) を使用している場合は、この関数から返される ID の代わりに、XSTS SSO トークンのペアワイズ ID を使用してください。
* それ以外の場合は、[XSystemGetAppSpecificDeviceId](/reference/system/xsystem/functions/xsystemgetappspecificdeviceid) 関数を使用してください。

## Requirements

**ヘッダー:** XSystem.h

**ライブラリ:** xgameruntime.lib

**サポートされているプラットフォーム:** Windows、XBOX One ファミリー本体および XBOX Series 本体

## Conceptual documentation

* [タイム センシティブ スレッド](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## See also

[開発キットのアクティブ化 (NDA トピック)](/home/setup-install/devkits/setup/activating-dev-kit)\
[XSystemGetXboxLiveSandbodId](/reference/system/xsystem/functions/xsystemgetxboxlivesandboxid)\
[XSystem](/reference/system/xsystem/xsystem_members)