Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Gets the access policy of the lobby.
Syntax
HRESULT PFLobbyGetAccessPolicy(
PFLobbyHandle lobby,
PFLobbyAccessPolicy* accessPolicy
)
Parameters
lobby PFLobbyHandle
The handle of the lobby.
accessPolicy PFLobbyAccessPolicy*
output
The output access policy.
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::accessPolicyUpdated 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::accessPolicyUpdated 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