PartyNetwork::GetInvitations

Gets an array containing all invitations exposed to the local device.

Syntax

PartyError GetInvitations(  
    uint32_t* invitationCount,  
    PartyInvitationArray* invitations  
)  

Parameters

invitationCount   uint32_t*
output

An output value indicating the number of invitations provided in invitations.

invitations   PartyInvitationArray*
library-allocated output array of size *invitationCount

A library-allocated output array containing the invitations that have been created for 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

The array is backed by the library's internal memory. The array is only valid until the next call to either CreateInvitation() or PartyManager::StartProcessingStateChanges().

A new invitation is exposed to the local device whenever the local device calls CreateInvitation() or a PartyInvitationCreatedStateChange is provided via PartyManager::StartProcessingStateChanges().

Invitations created via CreateInvitation() will only be exposed to the local device. The initial invitation will be exposed to all devices in the network via a PartyInvitationCreatedStateChange.

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

Requirements

Header: Party.h

See also

PartyNetwork
PartyManager::CreateNewNetwork
PartyNetwork::CreateInvitation
PartyNetwork::RevokeInvitation
PartyInvitationCreatedStateChange
PartyInvitationDestroyedStateChange