Edit

Share via

PartyManager::GetNetworks

  • Article

Gets an array of all networks to which the local device is connected or connecting.

Syntax

PartyError GetNetworks(  
    uint32_t* networkCount,  
    PartyNetworkArray* networks  
)

Parameters

networkCount   uint32_t*
output

The output number of networks to which the local device is connected or connecting provided in networks.

networks   PartyNetworkArray*
library-allocated output array of size *networkCount

A library-allocated output array containing the networks to which the local device is connected or connecting.

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 PartyNetworkDestroyedStateChange has been provided by PartyManager::StartProcessingStateChanges(), the network 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 ConnectToNetwork() returns success.

Requirements

Header: Party.h

See also

PartyManager
PartyManager::ConnectToNetwork
PartyNetwork::LeaveNetwork
PartyNetworkDestroyedStateChange