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

# ListUsers

> IXtfUserClient::ListUsers

# IXtfUserClient::ListUsers

Retorna uma lista de todos os usuários associados atualmente a este console.

## Sintaxe

```cpp theme={null}
public:
HRESULT ListUsers(
         XTF_USER_DATA **ppUserData,
         UINT32 *pCount
)  
```

### Parâmetros

*ppUserData*\
Tipo: XTF\_USER\_DATA \*\*

Em caso de retorno bem-sucedido, aponta para uma matriz de objetos [XTF\_USER\_DATA](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/structures/XTF_USER_DATA-xtfuser-xbox-windows-t.md) que descrevem os usuários associados atualmente ao console.

*pCount*\
Tipo: UINT32 \*

Em caso de retorno bem-sucedido, a contagem de elementos na matriz *ppUserData*.

### Valor retornado

Tipo: HRESULT

Código de sucesso ou de erro HRESULT.

## Comentários

Seu código de chamada é responsável por liberar a memória associada a *ppUserData* usando `CoTaskMemFree`.

Se um usuário for um usuário patrocinado (convidado), o valor de `szEmailAddress` no objeto [XTF\_USER\_DATA](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/structures/XTF_USER_DATA-xtfuser-xbox-windows-t.md) será uma cadeia de caracteres vazia, e `szGamertag` será derivado do gamertag do usuário patrocinador.

Se um usuário nunca tiver entrado neste console, `szGamertag` será uma cadeia de caracteres vazia.

Para adicionar um usuário a este console, use [AddUser](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/adduser-ixtfuserclient-xtfuser-xbox-windows-m.md). Para adicionar um usuário convidado, use [AddSponsoredUser](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/addsponsoreduser-ixtfuserclient-xtfuser-xbox-windows-m.md).

## Requisitos

**Cabeçalho:** xtfuser.h

**Biblioteca:** xtfuser.lib

**Plataformas com suporte:** Windows (para ferramentas de console XBOX)

## Confira também

[Interface IXtfUserClient](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/classes/IXtfUserClient/ixtfuserclient-xtfuser-xbox-windows-t.md)


## Related topics

- [XTF_USER_DATA](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/structures/XTF_USER_DATA-xtfuser-xbox-windows-t.md)
- [PairControllerWithUser](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/paircontrollerwithuser-ixtfuserclient-xtfuser-xbox-windows-m.md)
- [PairControllerWithUserId](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/paircontrollerwithuserid-ixtfuserclient-xtfuser-xbox-windows-m.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)
- [ListUsersEx](https://docs.xbox.com/pt-BR/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/ixtfuserclient_listusersex.md)