PFLobbyGetOwnerMigrationPolicy

Gets the owner migration policy of the lobby.

Syntax

HRESULT PFLobbyGetOwnerMigrationPolicy(  
    PFLobbyHandle lobby,  
    PFLobbyOwnerMigrationPolicy* ownerMigrationPolicy  
)  

Parameters

lobby   PFLobbyHandle

The handle of the lobby.

ownerMigrationPolicy   PFLobbyOwnerMigrationPolicy*
output

The output owner migration 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

The owner migration policy cannot change for the lifetime of the lobby.

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

Requirements

Header: PFLobby.h

See also

PFLobby members