PFLobbySendInvite
Send an invite to this lobby from the local user to the invited entity.
Syntax
HRESULT PFLobbySendInvite(
PFLobbyHandle lobby,
const PFEntityKey* sender,
const PFEntityKey* invitee,
void* asyncContext
)
Parameters
lobby
PFLobbyHandle
The handle of the lobby.
sender
PFEntityKey*
The local user sending the invite.
invitee
PFEntityKey*
The invited entity.
asyncContext
void*
optional
An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.
Return value
Type: HRESULT
S_OK
if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PFMultiplayerGetErrorMessage().
Remarks
This is an asynchronous operation. Upon successful completion, the title will be provided a PFLobbySendInviteCompletedStateChange with the PFLobbySendInviteCompletedStateChange::result field set to S_OK
. Upon a failed completion, the title will be provided a PFLobbySendInviteCompletedStateChange with the PFLobbySendInviteCompletedStateChange::result field set to a failure.
The sender
must be a local user of this lobby which joined from this client.
Requirements
Header: PFLobby.h