Edit

Share via

PartyManager::GetLocalUsers

  • Article

Gets an array containing all local users created by CreateLocalUser() or CreateLocalUserWithEntityType().

Syntax

PartyError GetLocalUsers(  
    uint32_t* userCount,  
    PartyLocalUserArray* localUsers  
)

Parameters

userCount   uint32_t*
output

The output number of local users provided in localUsers.

localUsers   PartyLocalUserArray*
library-allocated output array of size *userCount

A library-allocated output array containing the local users.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via GetErrorMessage().

Remarks

Once a PartyDestroyLocalUserCompletedStateChange has been provided by PartyManager::StartProcessingStateChanges(), the local user will no longer be present in the array returned by this method.

The memory for the returned array is invalidated whenever the title calls PartyManager::StartProcessingStateChanges(), or when CreateLocalUser() or CreateLocalUserWithEntityType() returns success.

Requirements

Header: Party.h

See also

PartyManager
PartyManager::CreateLocalUser
PartyManager::CreateLocalUserWithEntityType
PartyManager::DestroyLocalUser
PartyDestroyLocalUserCompletedStateChange