Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 2.35 KB

pflobbygetmembershiplock.md

File metadata and controls

53 lines (33 loc) · 2.35 KB
Raw
author title description ms.author ms.topic ms.service ms.date
ScottMunroMS
PFLobbyGetMembershipLock
Gets the lobby's current membership lock state.
scmunro
reference
playfab
03/07/2023

PFLobbyGetMembershipLock

Gets the lobby's current membership lock state.

Syntax

HRESULT PFLobbyGetMembershipLock(  
    PFLobbyHandle lobby,  
    PFLobbyMembershipLock* lockState  
)

Parameters

lobby   PFLobbyHandle

The handle of the lobby.

lockState   PFLobbyMembershipLock*
output

The output membership lock state.

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

If this lobby object was created by calling PFMultiplayerJoinLobby(), this method will return an error until PFMultiplayerStartProcessingLobbyStateChanges() provides a PFLobbyUpdatedStateChange with PFLobbyUpdatedStateChange::membershipLockUpdated set to true. If joining the lobby succeeds, this field is guaranteed to be populated by the time PFMultiplayerStartProcessingLobbyStateChanges() provides a PFLobbyJoinLobbyCompletedStateChange.

If this lobby object was created by calling PFMultiplayerClaimServerLobby(), this method will return an error until PFMultiplayerStartProcessingLobbyStateChanges() provides a PFLobbyUpdatedStateChange with PFLobbyUpdatedStateChange::membershipLockUpdated set to true. If claiming the lobby succeeds, this field is guaranteed to be populated by the time PFMultiplayerStartProcessingLobbyStateChanges() provides a PFLobbyClaimServerLobbyCompletedStateChange.

Requirements

Header: PFLobby.h

See also

PFLobby members