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

# IXtfUserClient::ListUsers

> IXtfUserClient::ListUsers

# IXtfUserClient::ListUsers

返回当前与此主机关联的所有用户的列表。

<a id="syntaxSection" />

## 语法

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

<a id="ID4EG" />

<a id="parametersSection" />

### 参数

*ppUserData*\
类型：XTF\_USER\_DATA \*\*

成功返回时，指向一个 [XTF\_USER\_DATA](/reference/tools/xtf/xtfuser/structures/XTF_USER_DATA-xtfuser-xbox-windows-t) 对象数组，描述当前与该主机关联的用户。

*pCount*\
类型：UINT32 \*

成功返回时，*ppUserData* 数组中的元素数量。

<a id="ID4EP" />

<a id="retvalSection" />

### 返回值

类型：HRESULT

HRESULT 成功或错误代码。

<a id="remarks" />

<a id="remarksSection" />

## 备注

调用方代码负责使用 `CoTaskMemFree` 释放与 *ppUserData* 关联的内存。

如果用户是受赞助（来宾）用户，则 [XTF\_USER\_DATA](/reference/tools/xtf/xtfuser/structures/XTF_USER_DATA-xtfuser-xbox-windows-t) 对象中 `szEmailAddress` 的值为空字符串，而 `szGamertag` 派生自赞助用户的玩家代号。

如果用户从未在此主机上登录过，则 `szGamertag` 为空字符串。

若要向此主机添加用户，请使用 [AddUser](/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/adduser-ixtfuserclient-xtfuser-xbox-windows-m)。若要添加来宾用户，请使用 [AddSponsoredUser](/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/addsponsoreduser-ixtfuserclient-xtfuser-xbox-windows-m)。

<a id="requirementsSection" />

## 要求

**头文件：** xtfuser.h

**库：** xtfuser.lib

**支持的平台：** Windows（用于 XBOX 主机工具）

<a id="seealsoSection" />

## 另请参阅

[IXtfUserClient 接口](/reference/tools/xtf/xtfuser/classes/IXtfUserClient/ixtfuserclient-xtfuser-xbox-windows-t)


## Related topics

- [XTF_USER_DATA](/zh-CN/reference/tools/xtf/xtfuser/structures/XTF_USER_DATA-xtfuser-xbox-windows-t.md)
- [IXtfUserClient::ListUsersEx](/zh-CN/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/ixtfuserclient_listusersex.md)
- [IXtfUserClient::PairControllerWithUser Method](/zh-CN/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/paircontrollerwithuser-ixtfuserclient-xtfuser-xbox-windows-m.md)
- [IXtfUserClient::PairControllerWithUserId Method](/zh-CN/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/paircontrollerwithuserid-ixtfuserclient-xtfuser-xbox-windows-m.md)
- [IXtfUserClient::DeleteUser](/zh-CN/reference/tools/xtf/xtfuser/classes/IXtfUserClient/methods/deleteuser-ixtfuserclient-xtfuser-xbox-windows-m.md)