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

# XUser

> XUser

# XUser

Material de referência para as APIs XUser.

## Funções

| Função | Descrição |
| - | - |
| [XUserAddAsync](/pt-BR/reference/system/xuser/functions/xuseraddasync) | Adiciona de forma assíncrona um usuário a uma sessão de jogo. |
| [XUserAddByIdWithUiAsync](/pt-BR/reference/system/xuser/functions/xuseraddbyidwithuiasync) | Adiciona de forma assíncrona um usuário a uma sessão de jogo com base em um XUID de um convite de jogo. Esta função só deve ser usada em resposta a um convite de jogo. |
| [XUserAddByIdWithUiResult](/pt-BR/reference/system/xuser/functions/xuseraddbyidwithuiresult) | Recupera um identificador para o usuário criado por XUserAddByIdWithUiAsync. Esta função só deve ser usada em resposta a um convite de jogo. |
| [XUserAddResult](/pt-BR/reference/system/xuser/functions/xuseraddresult) | Recupera um identificador para um usuário criado por XUserAddAsync. |
| [XUserChangeEventCallback](/pt-BR/reference/system/xuser/functions/xuserchangeeventcallback) | Um retorno de chamada que um aplicativo define para um evento de alteração de usuário. |
| [XUserCheckPrivilege](/pt-BR/reference/system/xuser/functions/xusercheckprivilege) | Determina se um usuário tem um privilégio específico. |
| [XUserCloseHandle](/pt-BR/reference/system/xuser/functions/xuserclosehandle) | Fecha um identificador de usuário específico. |
| [XUserCloseSignOutDeferralHandle](/pt-BR/reference/system/xuser/functions/xuserclosesignoutdeferralhandle) | Fecha um identificador de adiamento de saída de usuário específico. |
| [XUserCompare](/pt-BR/reference/system/xuser/functions/xusercompare) | Compara dois identificadores de usuário quanto à igualdade. |
| [XUserDefaultAudioEndpointUtf16ChangedCallback](/pt-BR/reference/system/xuser/functions/xuserdefaultaudioendpointutf16changedcallback) | Um retorno de chamada que um aplicativo define e invoca quando o ponto de extremidade de áudio padrão de um usuário é alterado. |
| [XUserDeviceAssociationChangedCallback](/pt-BR/reference/system/xuser/functions/xuserdeviceassociationchangedcallback) | Um retorno de chamada invocado quando a associação usuário-dispositivo é alterada. |
| [XUserDuplicateHandle](/pt-BR/reference/system/xuser/functions/xuserduplicatehandle) | Duplica um identificador de usuário. |
| [XUserFindControllerForUserWithUiAsync](/pt-BR/reference/system/xuser/functions/xuserfindcontrollerforuserwithuiasync) | Mostra uma caixa de diálogo que solicitará ao usuário que ligue e identifique qual controle deseja usar. |
| [XUserFindControllerForUserWithUiResult](/pt-BR/reference/system/xuser/functions/xuserfindcontrollerforuserwithuiresult) | Recupera a ID do dispositivo local do aplicativo (APP\_LOCAL\_DEVICE\_ID) que um usuário escolheu usar. |
| [XUserFindForDevice](/pt-BR/reference/system/xuser/functions/xuserfindfordevice) | Recupera a ID de usuário de uma ID de dispositivo específica. |
| [XUserFindUserById](/pt-BR/reference/system/xuser/functions/xuserfinduserbyid) | Recupera a ID de usuário do XBox (XUID) de um usuário local. |
| [XUserFindUserByLocalId](/pt-BR/reference/system/xuser/functions/xuserfinduserbylocalid) | Recupera um identificador para o usuário de uma ID de usuário local específica. |
| [XUserGetAgeGroup](/pt-BR/reference/system/xuser/functions/xusergetagegroup) | Retorna a faixa etária de um usuário. |
| [XUserGetDefaultAudioEndpointUtf16](/pt-BR/reference/system/xuser/functions/xusergetdefaultaudioendpointutf16) | Recupera o ponto de extremidade de áudio padrão de um usuário específico. |
| [XUserGetGamerPictureAsync](/pt-BR/reference/system/xuser/functions/xusergetgamerpictureasync) | Recupera de forma assíncrona a imagem de jogador de um usuário específico. |
| [XUserGetGamerPictureResult](/pt-BR/reference/system/xuser/functions/xusergetgamerpictureresult) | Recupera o resultado de uma chamada para XUserGetGamerPictureAsync. |
| [XUserGetGamerPictureResultSize](/pt-BR/reference/system/xuser/functions/xusergetgamerpictureresultsize) | Retorna o tamanho do buffer que [XUserGetGamerPictureResult](/pt-BR/reference/system/xuser/functions/xusergetgamerpictureresult) exige para recuperar a imagem de jogador retornada por [XUserGetGamerPictureAsync](/pt-BR/reference/system/xuser/functions/xusergetgamerpictureasync). |
| [XUserGetGamertag](/pt-BR/reference/system/xuser/functions/xusergetgamertag) | Recupera o gamertag de um usuário específico. |
| [XUserGetId](/pt-BR/reference/system/xuser/functions/xusergetid) | Obtém a ID de usuário de um usuário específico. |
| [XUserGetIsGuest](/pt-BR/reference/system/xuser/functions/xusergetisguest) | Retorna um booliano que indica se um usuário é convidado. |
| [XUserGetLocalId](/pt-BR/reference/system/xuser/functions/xusergetlocalid) | Recupera uma ID de sessão de jogo exclusiva de um usuário. |
| [XUserGetMaxUsers](/pt-BR/reference/system/xuser/functions/xusergetmaxusers) | Recupera o número máximo de usuários que uma sessão de jogo permite na plataforma atual. |
| [XUserGetMsaTokenSilentlyAsync](/pt-BR/reference/system/xuser/functions/xusergetmsatokensilentlyasync) | Esta função foi preterida. |
| [XUserGetMsaTokenSilentlyResult](/pt-BR/reference/system/xuser/functions/xusergetmsatokensilentlyresult) | Esta função foi preterida. |
| [XUserGetMsaTokenSilentlyResultSize](/pt-BR/reference/system/xuser/functions/xusergetmsatokensilentlyresultsize) | Esta função foi preterida. |
| [XUserGetSignOutDeferral](/pt-BR/reference/system/xuser/functions/xusergetsignoutdeferral) | Recupera um identificador para o adiamento de saída. |
| [XUserGetState](/pt-BR/reference/system/xuser/functions/xusergetstate) | Recupera o estado de um usuário. |
| [XUserGetTokenAndSignatureAsync](/pt-BR/reference/system/xuser/functions/xusergettokenandsignatureasync) | Recupera de forma assíncrona xtokens e assinaturas para solicitações da Web. |
| [XUserGetTokenAndSignatureResult](/pt-BR/reference/system/xuser/functions/xusergettokenandsignatureresult) | Obtém o resultado de uma chamada para XUserGetTokenAndSignatureAsync. |
| [XUserGetTokenAndSignatureResultSize](/pt-BR/reference/system/xuser/functions/xusergettokenandsignatureresultsize) | Obtém o tamanho do buffer para armazenar os resultados de uma chamada para XUserGetTokenAndSignatureAsync. |
| [XUserGetTokenAndSignatureUtf16Async](/pt-BR/reference/system/xuser/functions/xusergettokenandsignatureutf16async) | Recupera de forma assíncrona xtokens e assinaturas Unicode para solicitações da Web. |
| [XUserGetTokenAndSignatureUtf16Result](/pt-BR/reference/system/xuser/functions/xusergettokenandsignatureutf16result) | Obtém o resultado de uma chamada para XUserGetTokenAndSignatureUtf16Async. |
| [XUserGetTokenAndSignatureUtf16ResultSize](/pt-BR/reference/system/xuser/functions/xusergettokenandsignatureutf16resultsize) | Obtém o tamanho do buffer para armazenar os resultados de uma chamada para XUserGetTokenAndSignatureUtf16Async. |
| [XUserIsStoreUser](/pt-BR/reference/system/xuser/functions/xuserisstoreuser) | Verifica se a MSA do XUser é a mesma MSA conectada à Microsoft Store. |
| [XUserRegisterForChangeEvent](/pt-BR/reference/system/xuser/functions/xuserregisterforchangeevent) | Registra um retorno de chamada para um evento de alteração de usuário. |
| [XUserRegisterForDefaultAudioEndpointUtf16Changed](/pt-BR/reference/system/xuser/functions/xuserregisterfordefaultaudioendpointutf16changed) | Registra um retorno de chamada que o aplicativo define e invoca quando o ponto de extremidade de áudio padrão é alterado. |
| [XUserRegisterForDeviceAssociationChanged](/pt-BR/reference/system/xuser/functions/xuserregisterfordeviceassociationchanged) | Registra um retorno de chamada para eventos de alteração de associação de dispositivo do usuário. |
| [XUserResolveIssueWithUiAsync](/pt-BR/reference/system/xuser/functions/xuserresolveissuewithuiasync) | Exibe uma interface do usuário do sistema para resolver problemas de token com uma URL não Unicode. |
| [XUserResolveIssueWithUiResult](/pt-BR/reference/system/xuser/functions/xuserresolveissuewithuiresult) | Recupera o resultado de uma chamada para XUserResolveIssueWithUiAsync. |
| [XUserResolveIssueWithUiUtf16Async](/pt-BR/reference/system/xuser/functions/xuserresolveissuewithuiutf16async) | Exibe uma interface do usuário do sistema para resolver problemas de token com uma URL Unicode específica. |
| [XUserResolveIssueWithUiUtf16Result](/pt-BR/reference/system/xuser/functions/xuserresolveissuewithuiutf16result) | Recupera o resultado de uma chamada para XUserResolveIssueWithUiUtf16Async. |
| [XUserResolvePrivilegeWithUiAsync](/pt-BR/reference/system/xuser/functions/xuserresolveprivilegewithuiasync) | Exibe uma interface do usuário de resolução para os privilégios de usuário necessários. |
| [XUserResolvePrivilegeWithUiResult](/pt-BR/reference/system/xuser/functions/xuserresolveprivilegewithuiresult) | Recupera o resultado de uma chamada para XUserResolvePrivilegeWithUiAsync. |
| [XUserUnregisterForChangeEvent](/pt-BR/reference/system/xuser/functions/xuserunregisterforchangeevent) | Cancela o registro de um retorno de chamada de alteração de usuário registrado anteriormente. |
| [XUserUnregisterForDefaultAudioEndpointUtf16Changed](/pt-BR/reference/system/xuser/functions/xuserunregisterfordefaultaudioendpointutf16changed) | Cancela o registro de um retorno de chamada de alteração do ponto de extremidade de áudio padrão registrado anteriormente. |
| [XUserUnregisterForDeviceAssociationChanged](/pt-BR/reference/system/xuser/functions/xuserunregisterfordeviceassociationchanged) | Cancela o registro de um retorno de chamada de alteração de associação de dispositivo do usuário registrado anteriormente. |
| [xUserPlatformRemoteConnectSetEventHandlers](/pt-BR/reference/system/xuser/functions/xuserplatformremoteconnectseteventhandlers) | Define os manipuladores de eventos de conexão remota |
| [XUserPlatformRemoteConnectCancelPrompt](/pt-BR/reference/system/xuser/functions/xuserplatformremoteconnectcancelprompt) | Sinaliza ao XUser que o prompt de conexão remota foi descartado pelo usuário. |
| [XUserPlatformRemoteConnectShowPromptEventHandler](/pt-BR/reference/system/xuser/functions/xuserplatformremoteconnectshowprompteventhandler) | Manipulador de eventos para mostrar o prompt de autenticação de conexão remota. |
| [XUserPlatformRemoteConnectClosePromptEventHandler](/pt-BR/reference/system/xuser/functions/xuserplatformremoteconnectcloseprompteventhandler) | Manipulador de eventos para fechar o prompt de autenticação remota. |
| [XUserPlatformSpopPromptEventHandler](/pt-BR/reference/system/xuser/functions/xuserplatformspopprompteventhandler) | Manipulador de eventos para mostrar o prompt da operação SPOP |
| [XUserPlatformSpopPromptSetEventHandlers](/pt-BR/reference/system/xuser/functions/xuserplatformspoppromptseteventhandlers) | Define o manipulador de eventos do prompt SPOP. |
| [XUserPlatformSpopPromptClearEventHandler](/pt-BR/reference/system/xuser/functions/xuserplatformspoppromptcleareventhandler) | Limpa o manipulador de eventos do prompt SPOP no XUser. |
| [XUserPlatformSpopPromptComplete](/pt-BR/reference/system/xuser/functions/xuserplatformspoppromptcomplete) | Sinaliza ao XUser que o usuário terminou de interagir com o prompt SPOP. |

## Estruturas

| Estrutura | Descrição |
| - | - |
| [APP\_LOCAL\_DEVICE\_ID](/pt-BR/reference/system/xuser/structs/app_local_device_id) | Especifica a ID raiz de um dispositivo de entrada local. |
| [XUserDeviceAssociationChange](/pt-BR/reference/system/xuser/structs/xuserdeviceassociationchange) | Especifica as associações de dispositivo antigas e novas quando uma associação de dispositivo é alterada. |
| [XUserGetTokenAndSignatureData](/pt-BR/reference/system/xuser/structs/xusergettokenandsignaturedata) | Especifica os xtokens e as assinaturas que recuperamos para solicitações da Web. |
| [XUserGetTokenAndSignatureHttpHeader](/pt-BR/reference/system/xuser/structs/xusergettokenandsignaturehttpheader) | Especifica o cabeçalho HTTP de uma solicitação da Web. |
| [XUserGetTokenAndSignatureUtf16Data](/pt-BR/reference/system/xuser/structs/xusergettokenandsignatureutf16data) | Contém xtokens e assinaturas Unicode para solicitações da Web. |
| [XUserGetTokenAndSignatureUtf16HttpHeader](/pt-BR/reference/system/xuser/structs/xusergettokenandsignatureutf16httpheader) | Contém um cabeçalho HTTP Unicode para uma solicitação da Web. |
| [XUserLocalId](/pt-BR/reference/system/xuser/structs/xuserlocalid) | Especifica uma ID de sessão de jogo para um usuário. |
| [XUserPlatformRemoteConnectEventHandlers](/pt-BR/reference/system/xuser/structs/xuserplatformremoteconnecteventhandlers) | Encapsula os manipuladores de eventos de conexão remota |

## Enumerações

| Enumeração | Descrição |
| - | - |
| [XUserAddOptions](/pt-BR/reference/system/xuser/enums/xuseraddoptions) | Especifica as opções para adicionar um usuário. |
| [XUserAgeGroup](/pt-BR/reference/system/xuser/enums/xuseragegroup) | Especifica a faixa etária de um usuário. |
| [XUserChangeEvent](/pt-BR/reference/system/xuser/enums/xuserchangeevent) | Especifica o tipo de evento de alteração de usuário. |
| [XUserDefaultAudioEndpointKind](/pt-BR/reference/system/xuser/enums/xuserdefaultaudioendpointkind) | Especifica se o ponto de extremidade de áudio padrão do usuário renderiza ou captura áudio. |
| [XUserGamerPictureSize](/pt-BR/reference/system/xuser/enums/xusergamerpicturesize) | Especifica o tamanho da imagem de jogador em pixels. |
| [XUserGamertagComponent](/pt-BR/reference/system/xuser/enums/xusergamertagcomponent) | Especifica o tipo (ou componente) de gamertag a ser buscado. |
| [XUserGetMsaTokenSilentlyOptions](/pt-BR/reference/system/xuser/enums/xusergetmsatokensilentlyoptions) | Opções para XUserGetMsaTokenSilentlyOptions. |
| [XUserGetTokenAndSignatureOptions](/pt-BR/reference/system/xuser/enums/xusergettokenandsignatureoptions) | Opções para GetUserTokenAndSignatureAsync. |
| [XUserPrivilege](/pt-BR/reference/system/xuser/enums/xuserprivilege) | Especifica os privilégios de um usuário. |
| [XUserPrivilegeDenyReason](/pt-BR/reference/system/xuser/enums/xuserprivilegedenyreason) | Especifica o motivo pelo qual um usuário não pôde obter um privilégio. |
| [XUserPrivilegeOptions](/pt-BR/reference/system/xuser/enums/xuserprivilegeoptions) | Especifica as opções de privilégio do usuário. |
| [XUserState](/pt-BR/reference/system/xuser/enums/xuserstate) | Especifica o estado atual do usuário. |
| [XUserPlatformOperationResult](/pt-BR/reference/system/xuser/enums/XUserPlatformOperationResult) | Enumeração que define os resultados de uma operação de cliente |
| [XUserPlatformSpopOperationResult](/pt-BR/reference/system/xuser/enums/xuserplatformspopoperationresult) | Enumeração que define os resultados de uma operação de cliente. |

## Documentação conceitual

* [Metas de design e melhorias da programação assíncrona](/pt-BR/build/core-features/common/async/async-whitepaper)
* [Visão geral do WinHTTP](/pt-BR/build/console-features/networking/web-requests/intro-winhttp)
* [Solicitações da Web (conteúdo)](/pt-BR/build/console-features/networking/web-requests/web-requests-toc)
* [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)
* [Usando wrappers C# para APIs do GDK em seu projeto do Unity](/pt-BR/build/gdk-and-engines/unity/unity-api-wrappers)

## Confira também

[Referência da API do sistema](/pt-BR/reference/system/gc-reference-system-toc)

## Códigos de erro

Os códigos de erro a seguir podem ser retornados pelas APIs XUser. Para obter uma lista completa, consulte [Códigos de erro](/pt-BR/reference/errorcodes).

| Código | Valor | Descrição |
| - | - | - |
| E\_GAMEUSER\_MAX\_USERS\_ADDED | 0x89245100 | Não é possível adicionar este usuário porque o número máximo de usuários foi atingido. |
| E\_GAMEUSER\_SIGNED\_OUT | 0x89245101 | Não é possível executar a operação porque o usuário saiu. |
| E\_GAMEUSER\_RESOLVE\_USER\_ISSUE\_REQUIRED | 0x89245102 | A UI é necessária para resolver um problema com este usuário. |
| E\_GAMEUSER\_DEFERRAL\_NOT\_AVAILABLE | 0x89245103 | Não é um momento apropriado para solicitar o adiamento. |
| E\_GAMEUSER\_USER\_NOT\_FOUND | 0x89245104 | O usuário correspondente à ID não foi encontrado. |
| E\_GAMEUSER\_NO\_TOKEN\_REQUIRED | 0x89245105 | Nenhum token é necessário para esta chamada. |
| E\_GAMEUSER\_NO\_DEFAULT\_USER | 0x89245106 | Não há um usuário padrão atual. Se você receber este erro, chame XUserAddAsync novamente sem AddDefaultUserSilently. |
| E\_GAMEUSER\_FAILED\_TO\_RESOLVE | 0x89245107 | Falha ao resolver o privilégio fornecido. |
| E\_GAMEUSER\_NO\_TITLE\_ID | 0x89245108 | Um TitleId do XBOX Live deve ser configurado. |
| E\_GAMEUSER\_UNKNOWN\_GAME\_IDENTITY | 0x89245109 | A identidade do jogo não é reconhecida. O MSAAppId e o TitleId não correspondem aos associados ao jogo. |
| E\_GAMEUSER\_NO\_PACKAGE\_IDENTITY | 0x89245110 | Uma identidade de pacote deve ser configurada. |
| E\_GAMEUSER\_FAILED\_TO\_GET\_TOKEN | 0x89245111 | A solicitação de token falhou. |
| E\_GAMEUSER\_INVALID\_APP\_CONFIGURATION | 0x89245112 | O MSAAppId na configuração do jogo é inválido ou não está configurado para a pilha de autenticação. |
| E\_GAMEUSER\_MALFORMED\_MSAAPPID | 0x89245113 | O MSAAppId na configuração do jogo não corresponde ao formato esperado (cadeia de caracteres de 16 caracteres ou GUID). |
| E\_GAMEUSER\_INCONSISTENT\_MSAAPPID\_AND\_TITLEID | 0x89245114 | O MSAAppId e o TitleId na configuração do jogo não correspondem aos associados ao jogo. |


## Related topics

- [XUser](/reference/system/xuser/xuser_members.md)
- [User identity and XUser](/build/core-features/common/user/player-identity-xuser.md)
- [Users](/build/core-features/common/user/user-toc.md)
- [Headless automation of XUser](/build/core-features/common/user/users-headless-automation.md)
- [User identity and XUser APIs in the GDK](/build/core-features/common/user/index.md)