IXtfUserClient::ListUsers Method

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

Syntax

public:
HRESULT ListUsers(
         XTF_USER_DATA **ppUserData,
         UINT32 *pCount
)  

Parameters

ppUserData
Type: XTF_USER_DATA **

On successful return, points to an array of XTF_USER_DATA structures describing users currently associated with the console.

pCount
Type: UINT32 *

On successful return, the number of XTF_USER_DATA structures 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, using CoTaskMemFree.

If a user is a sponsored user, the szEmailAddress value returned is an empty string, and szGamertag is derived from the Gamertag of the sponsor user.

If a user has never been signed in on this console, then szGamertag is an empty string.

Requirements

Header: Declared in xtfuser.h.

Library: Use xtfuser.lib.