Edit

PartyNetwork::GetEndpoints

  • Article

Gets the endpoints in this network.

Syntax

PartyError GetEndpoints(  
    uint32_t* endpointCount,  
    PartyEndpointArray* endpoints  
)

Parameters

endpointCount   uint32_t*
output

The output number of PartyEndpoint entries in the endpoints array.

endpoints   PartyEndpointArray*
library-allocated output array of size *endpointCount

A library-allocated output array containing the endpoints in this 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

This method gets all endpoints currently associated with the network and visible to the local device.

All local endpoints that have successfully been created or are in the process of being created will be present in endpoints. All remote endpoints that have been successfully created will also be present.

Once a PartyEndpointDestroyedStateChange has been provided by PartyManager::StartProcessingStateChanges(), the endpoint 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 CreateEndpoint() returns success.

Requirements

Header: Party.h

See also

PartyNetwork
PartyEndpointCreatedStateChange
PartyEndpointDestroyedStateChange
PartyNetwork::CreateEndpoint