XblMultiplayerSendInvitesAsync
Invites the specified users to a session. This will result in a notification being shown to each invited user using standard invite text. If a user accepts that notification the title will be activated.
Syntax
HRESULT XblMultiplayerSendInvitesAsync(
XblContextHandle xblContext,
const XblMultiplayerSessionReference* sessionReference,
const uint64_t* xuids,
size_t xuidsCount,
uint32_t titleId,
const char* contextStringId,
const char* customActivationContext,
XAsyncBlock* async
)
Parameters
xblContext _In_
Type: XblContextHandle
Xbox live context for the local user.
sessionReference _In_
Type: XblMultiplayerSessionReference*
An XblMultiplayerSessionReference object representing the session the target users will be invited to.
xuids _In_
Type: uint64_t*
The list of xbox user IDs who will be invited.
xuidsCount _In_
Type: size_t
Size of the xuids array.
titleId _In_
Type: uint32_t
The ID of the title that the invited user will activate in order to join the session.
contextStringId _In_opt_z_
Type: char*
The custom context string ID. This string ID is defined during Xbox Live ingestion to identify the invitation text that is additional to the standard invitation text. The ID string must be prefixed with " /// ". Pass nullptr if you don't want a custom string added to the invite.
customActivationContext _In_opt_z_
Type: char*
The activation context string. A game defined string that is passed to the invited game client and interpreted as desired. (Optional)
async _In_
Type: XAsyncBlock*
The AsyncBlock for this operation.
Return value
Type: HRESULT
HRESULT return code for this API operation.
Requirements
Header: multiplayer_c.h
Library: Microsoft.Xbox.Services.14x.GDK.C.lib