PFMultiplayerGetLobbyInviteListenerStatus
Retrieve the status of the entity's invite listener.
Syntax
HRESULT PFMultiplayerGetLobbyInviteListenerStatus(
PFMultiplayerHandle handle,
const PFEntityKey* listeningEntity,
PFLobbyInviteListenerStatus* status
)
Parameters
handle PFMultiplayerHandle
The handle of the PFMultiplayer API instance.
listeningEntity PFEntityKey*
The entity which is listening for invites.
status PFLobbyInviteListenerStatus*
output
The output status value.
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 value is used to understand the state of an entity's invite listener. If the invite listener encounters a fatal error, non-fatal error, or diagnostic change, the listener's status value will reflect it.
When the invite listener's status changes, a PFLobbyInviteListenerStatusChangedStateChange struct will be provided by PFMultiplayerStartProcessingLobbyStateChanges. This method can then be called to retrieve the latest status and act accordingly.
Requirements
Header: PFLobby.h