Skip to main content

IXtfUserClient::ListUsers

Returns a list of all users currently associated with this console.

Syntax

Parameters

ppUserData
Type: XTF_USER_DATA **
On successful return, points to an array of XTF_USER_DATA objects describing users currently associated with the console. pCount
Type: UINT32 *
On successful return, the count of elements in the ppUserData array.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

Your calling code is responsible for freeing the memory associated with ppUserData by using CoTaskMemFree. If a user is a sponsored (guest) user, the value of szEmailAddress in the XTF_USER_DATA object is an empty string, and szGamertag is derived from the gamertag of the sponsoring user. If a user has never been signed in on this console, szGamertag is an empty string. To add a user to this console, use AddUser. To add a guest user, use AddSponsoredUser.

Requirements

Header: xtfuser.h Library: xtfuser.lib Supported platforms: Windows (for XBOX console tools)

See also

IXtfUserClient interface
Last modified on August 20, 2026