Skip to main content

XSystemGetConsoleId

Retorna a ID do console do dispositivo atual.

Sintaxe

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 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. 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

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.
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.

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

Confira também

Ativando seu kit de desenvolvimento (tópico sob NDA)
XSystemGetXboxLiveSandbodId
XSystem
Last modified on October 6, 2026