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

# XSystemGetConsoleId

> XSystemGetConsoleId

# XSystemGetConsoleId

Retorna a ID do console do dispositivo atual.

## Sintaxe

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

### Parâmetros

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

O tamanho de *consoleId*, em bytes. Esse valor deve ser igual ou maior que a constante **XSystemConsoleIdBytes** definida em XSystem.h.

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

O buffer de caracteres que receberá a ID do console.

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

O tamanho, em bytes, do buffer *consoleId* retornado.

### Valor retornado

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

Retornará **S\_OK** se for bem-sucedido; caso contrário, retornará um código de erro. Para obter uma lista de códigos de erro, consulte [Códigos de erro](https://docs.xbox.com/pt-BR/reference/errorcodes.md). Se a função falhar porque *consoleIdSize* está definido com um valor menor que **XSystemConsoleIdBytes**, o valor retornado será definido como **HRESULT\_FROM\_WIN32(ERROR\_INSUFFICIENT\_BUFFER)**.

## Comentários

> [!NOTE]
>
> Não é seguro chamar esta função em um thread sensível ao tempo. Para obter mais informações, consulte [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).

A ID do console identifica exclusivamente um dispositivo XBOX para o XBOX Live somente em cenários de desenvolvimento. A ID do console é usada para identificar o console para fins de registro em log e gerenciamento; por exemplo, para capturar informações de análise ou para determinar qual kit de desenvolvimento reinicializar em um ambiente de desenvolvimento. A ID retornada por esta função corresponde à ID do console exibida em Configurações \ Sistema \ Informações do console.

Para dispositivos XBOX, a ID do console é armazenada no dispositivo. Se a ID do console não for encontrada ou se você não tiver permissão para acessá-la, a ID do console usará como padrão `00000000.00000000.00000000.00000000.00`. Para dispositivos PC, a ID do console sempre usa como padrão `00000000.00000000.00000000.00000000.00`.

Em RETAIL, esta função sempre retornará `00000000.00000000.00000000.00000000.00`. Se o jogo precisar de um identificador que possa
ser usado em todas as situações, incluindo varejo, há duas possibilidades:

* Se o seu aplicativo estiver usando Logon Único (SSO), você deverá usar a ID pairwise do token SSO do XSTS em vez da ID retornada por esta função.
* Caso contrário, use a função [XSystemGetAppSpecificDeviceId](https://docs.xbox.com/pt-BR/reference/system/xsystem/functions/xsystemgetappspecificdeviceid.md).

## Requisitos

**Cabeçalho:** XSystem.h

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** Windows, consoles da família XBOX One e consoles XBOX Series

## Documentação conceitual

* [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Confira também

[Ativando seu kit de desenvolvimento (tópico sob NDA)](https://docs.xbox.com/pt-BR/home/setup-install/devkits/setup/activating-dev-kit.md)\
[XSystemGetXboxLiveSandbodId](https://docs.xbox.com/pt-BR/reference/system/xsystem/functions/xsystemgetxboxlivesandboxid.md)\
[XSystem](https://docs.xbox.com/pt-BR/reference/system/xsystem/xsystem_members.md)


## Related topics

- [XSystemGetXboxLiveSandboxId](https://docs.xbox.com/pt-BR/reference/system/xsystem/functions/xsystemgetxboxlivesandboxid.md)
- [XSystem (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xsystem/xsystem_members.md)
- [XSystemGetAppSpecificDeviceId](https://docs.xbox.com/pt-BR/reference/system/xsystem/functions/xsystemgetappspecificdeviceid.md)
- [GetSystemTime](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfconsolecontrol/interfaces/IXtfConsoleControlClient/methods/ixtfconsolecontrolclient_getsystemtime.md)
- [XtfGetConsoleFieldValue](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfapi/functions/xtfgetconsolefieldvalue-xbox-microsoft-m.md)