Edit

Share via

PartyNetwork::GetLocalUsers

  • Article

Gets an array containing the local users that are authenticated or authenticating into the network.

Syntax

PartyError GetLocalUsers(  
    uint32_t* userCount,  
    PartyLocalUserArray* localUsers  
)

Parameters

userCount   uint32_t*
output

An output value indicating the number of users provided in localUsers.

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

A library-allocated output array containing the local users that are authenticated or authenticating into the network.

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 PartyManager::GetErrorMessage().

Remarks

Once a PartyLocalUserRemovedStateChange 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 AuthenticateLocalUser() returns success.

Requirements

Header: Party.h

See also

PartyNetwork
PartyNetwork::AuthenticateLocalUser
PartyNetwork::RemoveLocalUser
PartyLocalUserRemovedStateChange