Edit

Share via

PFMultiplayerStopListeningForLobbyInvites

  • Article

Disables the Lobby invite listener for a given entity.

Syntax

HRESULT PFMultiplayerStopListeningForLobbyInvites(  
    PFMultiplayerHandle handle,  
    const PFEntityKey* listeningEntity  
)

Parameters

handle   PFMultiplayerHandle

The handle of the PFMultiplayer API instance.

listeningEntity   PFEntityKey*

The entity which is listening for invites.

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 operation will synchronously stop listening for invites on behalf of the provided entity.

Invite notifications which have already been queued internally will still be provided via the next call to PFMultiplayerStartProcessingLobbyStateChanges().

Lobby invites and this invite listener are unrelated to and unaffected by platform invite mechanisms.

This method may only be called if the Lobby invite listener is already enabled for the given entity.

Requirements

Header: PFLobby.h

See also

PFLobby members