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

# XUser (conteúdo da API)

> XUser

# XUser

Material de referência para as APIs XUser.

## Funções

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

## Estruturas

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

## Enumerações

| Enumeração | Descrição |
| - | - |
| [XUserAddOptions](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuseraddoptions.md) | Especifica as opções para adicionar um usuário. |
| [XUserAgeGroup](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuseragegroup.md) | Especifica a faixa etária de um usuário. |
| [XUserChangeEvent](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuserchangeevent.md) | Especifica o tipo de evento de alteração de usuário. |
| [XUserDefaultAudioEndpointKind](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuserdefaultaudioendpointkind.md) | Especifica se o ponto de extremidade de áudio padrão do usuário renderiza ou captura áudio. |
| [XUserGamerPictureSize](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xusergamerpicturesize.md) | Especifica o tamanho da imagem de jogador em pixels. |
| [XUserGamertagComponent](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xusergamertagcomponent.md) | Especifica o tipo (ou componente) de gamertag a ser buscado. |
| [XUserGetMsaTokenSilentlyOptions](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xusergetmsatokensilentlyoptions.md) | Opções para XUserGetMsaTokenSilentlyOptions. |
| [XUserGetTokenAndSignatureOptions](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xusergettokenandsignatureoptions.md) | Opções para GetUserTokenAndSignatureAsync. |
| [XUserPrivilege](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuserprivilege.md) | Especifica os privilégios de um usuário. |
| [XUserPrivilegeDenyReason](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuserprivilegedenyreason.md) | Especifica o motivo pelo qual um usuário não pôde obter um privilégio. |
| [XUserPrivilegeOptions](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuserprivilegeoptions.md) | Especifica as opções de privilégio do usuário. |
| [XUserState](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuserstate.md) | Especifica o estado atual do usuário. |
| [XUserPlatformOperationResult](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/XUserPlatformOperationResult.md) | Enumeração que define os resultados de uma operação de cliente |
| [XUserPlatformSpopOperationResult](https://docs.xbox.com/pt-BR/reference/system/xuser/enums/xuserplatformspopoperationresult.md) | 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](https://docs.xbox.com/pt-BR/build/core-features/common/async/async-whitepaper.md)
* [Visão geral do WinHTTP](https://docs.xbox.com/pt-BR/build/console-features/networking/web-requests/intro-winhttp.md)
* [Solicitações da Web (conteúdo)](https://docs.xbox.com/pt-BR/build/console-features/networking/web-requests/web-requests-toc.md)
* [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](https://docs.xbox.com/pt-BR/build/gdk-and-engines/unity/unity-api-wrappers.md)

## Confira também

[Referência da API do sistema](https://docs.xbox.com/pt-BR/reference/system/gc-reference-system-toc.md)

## 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](https://docs.xbox.com/pt-BR/reference/errorcodes.md).

| 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

- [XtfUser (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/xtfuser-xbox-windows-n.md)
- [Interface IXtfUserClient (conteúdo da interface)](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/classes/IXtfUserClient/ixtfuserclient-xtfuser-xbox-windows-t.md)
- [XStore (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xstore/xstore_members.md)
- [XAppCapture (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xappcapture/xappcapture_members.md)
- [XPersistentLocalStorage (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xpersistentlocalstorage/xpersistentlocalstorage_members.md)