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

# XUserGetGamertag

> XUserGetGamertag

# XUserGetGamertag

Recupera o gamertag de um usuário específico.

## Sintaxe

```cpp theme={null}
HRESULT XUserGetGamertag(  
         XUserHandle user,
         XUserGamertagComponent gamertagComponent,
         size_t gamertagSize,  
         char* gamertag,  
         size_t* gamertagUsed  
)  
```

### Parâmetros

*user*   \_In\_\
Tipo: XUserHandle

Um identificador para o usuário cujo gamertag será recuperado.

*gamertagComponent*   \_In\_\
Tipo: [XUserGamertagComponent](/pt-BR/reference/system/xuser/enums/xusergamertagcomponent)

Tipo de gamertag a ser recuperado.

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

Tamanho em bytes do buffer no parâmetro *gamertag*.

*gamertag*   \_Out\_writes\_bytes\_to\_(gamertagSize,*gamertagUsed)\
Tipo: char*

Contém o gamertag de um usuário específico.

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

Contém a quantidade do buffer usada para armazenar o gamertag.

### Valor retornado

Tipo: HRESULT

Código de sucesso ou erro HRESULT.

| Código de retorno | Descrição |
| - | - |
| S\_OK | A operação foi bem-sucedida. |
| E\_GAMEUSER\_RESOLVE\_USER\_ISSUE\_REQUIRED | O usuário deve usar uma interface do usuário para resolver o problema. Chame [XUserResolveIssueWithUiAsync](/pt-BR/reference/system/xuser/functions/xuserresolveissuewithuiasync) para exibir a interface do usuário. |
| E\_INSUFFICIENT\_BUFFER | O tamanho do buffer indicado por *gamertagSize* não é grande o suficiente para conter o componente solicitado. |
| E\_INVALIDARG | *gamertagComponent* inválido fornecido. |

Para obter uma lista de códigos de erro, consulte [Códigos de erro](/pt-BR/reference/errorcodes).

## Comentários

Para recuperar a ID de usuário de um usuário específico, chame [XUserGetId](/pt-BR/reference/system/xuser/functions/xusergetid).

Para recuperar o estado de um usuário específico, chame [XUserGetState](/pt-BR/reference/system/xuser/functions/xusergetstate).

Para recuperar a faixa etária de um usuário específico, chame [XUserGetAgeGroup](/pt-BR/reference/system/xuser/functions/xusergetagegroup).

## Requisitos

**Cabeçalho:** XUser.h

**Biblioteca:** xgameruntime.lib

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

## Confira também

[XUser](/pt-BR/reference/system/xuser/xuser_members)

[XUserGetId](/pt-BR/reference/system/xuser/functions/xusergetid)

[XUserGetState](/pt-BR/reference/system/xuser/functions/xusergetstate)

[XUserGetAgeGroup](/pt-BR/reference/system/xuser/functions/xusergetagegroup)


## Related topics

- [XUserGetGamertag](/reference/system/xuser/functions/xusergetgamertag.md)
- [XUserGamertagComponent](/reference/system/xuser/enums/xusergamertagcomponent.md)