> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # PFMultiplayer C/C++ API overview - PFLobby.h > PFMultiplayer C/C++ API overview - PFLobby.h ## Functions | Function | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [PFLobbyAddMember](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyaddmember) | Add a local user as a member to the lobby. | | [PFLobbyForceRemoveMember](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyforceremovemember) | Forcibly remove an entity from the lobby. | | [PFLobbyGetAccessPolicy](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetaccesspolicy) | Gets the access policy of the lobby. | | [PFLobbyGetConnectionString](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetconnectionstring) | Gets the default connection string associated with the lobby. | | [PFLobbyGetCustomContext](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetcustomcontext) | Retrieves the app's private, custom pointer-sized context value previously associated with this lobby object. | | [PFLobbyGetLobbyId](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetlobbyid) | Gets the ID of the Lobby. | | [PFLobbyGetLobbyProperty](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetlobbyproperty) | Get the lobby property value from its key. | | [PFLobbyGetLobbyPropertyKeys](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetlobbypropertykeys) | Get the list of lobby property keys. | | [PFLobbyGetMaxMemberCount](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmaxmembercount) | Gets the max member count of the lobby. | | [PFLobbyGetMemberConnectionStatus](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmemberconnectionstatus) | Determines a member's connection status to the notification service. | | [PFLobbyGetMemberProperty](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmemberproperty) | Get the member property's value from its key. | | [PFLobbyGetMemberPropertyKeys](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmemberpropertykeys) | Get a list of the specified member's property keys. | | [PFLobbyGetMembers](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmembers) | Gets the list of PlayFab entities currently joined to the lobby as members. | | [PFLobbyGetMembershipLock](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetmembershiplock) | Gets the lobby's current membership lock state. | | [PFLobbyGetOwner](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetowner) | Gets the current owner of the lobby. | | [PFLobbyGetOwnerMigrationPolicy](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetownermigrationpolicy) | Gets the owner migration policy of the lobby. | | [PFLobbyGetRestrictInvitesToLobbyOwner](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetrestrictinvitestolobbyowner) | Gets the lobby's current policy for whether only the lobby owner can send invites to join the lobby. | | [PFLobbyGetSearchProperty](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetsearchproperty) | Get the search property value from its key. | | [PFLobbyGetSearchPropertyKeys](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetsearchpropertykeys) | Get the list of search property keys. | | [PFLobbyGetServer](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetserver) | Gets the server entity joined to the lobby. | | [PFLobbyGetServerConnectionStatus](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetserverconnectionstatus) | Retrieves the lobby server's connection status to the notification service. | | [PFLobbyGetServerProperty](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetserverproperty) | Get the lobby server property's value from its key. | | [PFLobbyGetServerPropertyKeys](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbygetserverpropertykeys) | Get a list of the lobby server's property keys. | | [PFLobbyLeave](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyleave) | Request one or all local users to leave the lobby. | | [PFLobbyPostUpdate](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbypostupdate) | Post an update to the lobby as a player. | | [PFLobbySendInvite](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbysendinvite) | Send an invite to this lobby from the local user to the invited entity. | | [PFLobbyServerDeleteLobby](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverdeletelobby) | Delete a lobby on behalf of the game\_server entity that owns the lobby. | | [PFLobbyServerLeaveAsServer](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverleaveasserver) | Requests that the server leave the client-owned lobby it's currently in. | | [PFLobbyServerPostUpdate](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverpostupdate) | Post an update to the lobby as the server-owner. | | [PFLobbyServerPostUpdateAsServer](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbyserverpostupdateasserver) | Post an update to a client-owned lobby as a joined server. | | [PFLobbySetCustomContext](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pflobbysetcustomcontext) | Configures an optional, custom pointer-sized context value with this lobby object. | | [PFMultiplayerClaimServerLobby](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerclaimserverlobby) | Claim ownership of a pre-existing server lobby. | | [PFMultiplayerConnectToLobby](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerconnecttolobby) | Connect to a lobby in which the local PlayFab entity was already added as a member. | | [PFMultiplayerCreateAndClaimServerLobby](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayercreateandclaimserverlobby) | Create a new lobby as a game\_server entity. | | [PFMultiplayerCreateAndJoinLobby](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayercreateandjoinlobby) | Create a new lobby and add the creating PlayFab entity to it. | | [PFMultiplayerFindLobbies](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies) | Search for lobbies on behalf of the local user. | | [PFMultiplayerFinishProcessingLobbyStateChanges](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfinishprocessinglobbystatechanges) | Returns an array of PFLobbyStateChanges that were being processed. | | [PFMultiplayerGetLobbyInviteListenerStatus](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayergetlobbyinvitelistenerstatus) | Retrieve the status of the entity's invite listener. | | [PFMultiplayerJoinArrangedLobby](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinarrangedlobby) | Joins a lobby using an arrangement string provided by another service, such as matchmaking. If no one has joined the lobby yet, the lobby is initialized using the configuration parameters. | | [PFMultiplayerJoinLobby](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinlobby) | Join a lobby as the local PlayFab entity. | | [PFMultiplayerJoinLobbyAsServer](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerjoinlobbyasserver) | Join a client-owned lobby as a server. | | [PFMultiplayerStartListeningForLobbyInvites](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerstartlisteningforlobbyinvites) | Enables the Lobby invite listener for a given entity. | | [PFMultiplayerStartProcessingLobbyStateChanges](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerstartprocessinglobbystatechanges) | Retrieves an array of all PFLobbyStateChanges to process since the last such call. | | [PFMultiplayerStopListeningForLobbyInvites](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerstoplisteningforlobbyinvites) | Disables the Lobby invite listener for a given entity. | ## Structures | Structure | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [PFLobbyArrangedJoinConfiguration](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyarrangedjoinconfiguration) | The initial configuration data used when joining an arranged lobby. | | [PFLobbyCreateConfiguration](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbycreateconfiguration) | The initial configuration data used when creating a lobby. | | [PFLobbyDataUpdate](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbydataupdate) | A request to make an update to the shared portion of the lobby. | | [PFLobbyJoinConfiguration](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinconfiguration) | The initial configuration data used when joining a lobby. | | [PFLobbyMemberDataUpdate](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberdataupdate) | A request to make an update to the member-owned portion of the lobby document. | | [PFLobbyMemberUpdateSummary](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberupdatesummary) | A collection of hints about an update which has been successfully applied to the lobby on behalf of a member. | | [PFLobbySearchConfiguration](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysearchconfiguration) | The configuration structure used to specify how a [PFMultiplayerFindLobbies](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies) operation should be performed. | | [PFLobbySearchFriendsFilter](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysearchfriendsfilter) | The filter structure used to limit lobby search results to only those lobbies owned by the player's friends. | | [PFLobbySearchResult](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysearchresult) | An entry in the collection of lobby search results received upon successful completion of a [PFMultiplayerFindLobbies](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/functions/pfmultiplayerfindlobbies) operation. | | [PFLobbyServerDataUpdate](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverdataupdate) | A request to make an update to the associated server state of a client-owned lobby. | | [PFLobbyServerJoinConfiguration](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverjoinconfiguration) | The initial configuration data used when joining a client-owned lobby as a server. | ## State changes | State change | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | | [PFLobbyAddMemberCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyaddmembercompletedstatechange) | Information specific to the *AddMemberCompleted* type of state change. | | [PFLobbyClaimServerLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyclaimserverlobbycompletedstatechange) | Information specific to the *ClaimServerLobbyCompleted* type of state change. | | [PFLobbyConnectToLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyconnecttolobbycompletedstatechange) | Information specific to the *ConnectToLobbyCompleted* type of state change. | | [PFLobbyCreateAndClaimServerLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbycreateandclaimserverlobbycompletedstatechange) | Information specific to the *CreateAndClaimServerLobbyCompleted* type of state change. | | [PFLobbyCreateAndJoinLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbycreateandjoinlobbycompletedstatechange) | Information specific to the *CreateAndJoinLobbyCompleted* type of state change. | | [PFLobbyDisconnectedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbydisconnectedstatechange) | Information specific to the *Disconnected* type of state change. | | [PFLobbyDisconnectingStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbydisconnectingstatechange) | Information specific to the *Disconnecting* type of state change. | | [PFLobbyFindLobbiesCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyfindlobbiescompletedstatechange) | Information specific to the *FindLobbiesCompleted* type of state change. | | [PFLobbyForceRemoveMemberCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyforceremovemembercompletedstatechange) | Information specific to the *ForceRemoveMemberCompleted* type of state change. | | [PFLobbyInviteListenerStatusChangedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyinvitelistenerstatuschangedstatechange) | Information specific to the *InviteListenerStatusChanged* type of state change. | | [PFLobbyInviteReceivedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyinvitereceivedstatechange) | Information specific to the *InviteReceived* type of state change. | | [PFLobbyJoinArrangedLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinarrangedlobbycompletedstatechange) | Information specific to the *JoinArrangedLobbyCompleted* type of state change. | | [PFLobbyJoinLobbyAsServerCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinlobbyasservercompletedstatechange) | Information specific to the *JoinLobbyAsServerCompleted* type of state change. | | [PFLobbyJoinLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyjoinlobbycompletedstatechange) | Information specific to the *JoinLobbyCompleted* type of state change. | | [PFLobbyLeaveLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyleavelobbycompletedstatechange) | Information specific to the *LeaveLobbyCompleted* type of state change. | | [PFLobbyMemberAddedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberaddedstatechange) | Information specific to the *MemberAdded* type of state change. | | [PFLobbyMemberRemovedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbymemberremovedstatechange) | Information specific to the *MemberRemoved* type of state change. | | [PFLobbyPostUpdateCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbypostupdatecompletedstatechange) | Information specific to the *PostUpdateCompleted* type of state change. | | [PFLobbySendInviteCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbysendinvitecompletedstatechange) | Information specific to the *SendInviteCompleted* type of state change. | | [PFLobbyServerDeleteLobbyCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverdeletelobbycompletedstatechange) | Information specific to the *ServerDeleteLobbyCompleted* type of state change. | | [PFLobbyServerLeaveLobbyAsServerCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverleavelobbyasservercompletedstatechange) | Information specific to the *ServerLeaveLobbyAsServerCompleted* type of state change. | | [PFLobbyServerPostUpdateAsServerCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverpostupdateasservercompletedstatechange) | Information specific to the *ServerPostUpdateAsServerCompleted* type of state change. | | [PFLobbyServerPostUpdateCompletedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyserverpostupdatecompletedstatechange) | Information specific to the *ServerPostUpdateCompleted* type of state change. | | [PFLobbyStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbystatechange) | A generic, base structure representation of an event or change in state in the Lobby library. | | [PFLobbyUpdatedStateChange](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/structs/pflobbyupdatedstatechange) | Information specific to the *Updated* type of state change. | ## Enumerations | Enumeration | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | | [PFLobbyAccessPolicy](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbyaccesspolicy) | Values representing the lobby's access policy. | | [PFLobbyDisconnectingReason](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbydisconnectingreason) | Reasons the client no longer has access to the Lobby. | | [PFLobbyInviteListenerStatus](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbyinvitelistenerstatus) | Values representing the current status of an invite listener. | | [PFLobbyMemberConnectionStatus](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbymemberconnectionstatus) | Values representing the current status of a member's connection status to the notification service. | | [PFLobbyMemberRemovedReason](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbymemberremovedreason) | Reasons why a member was removed from a lobby. | | [PFLobbyMembershipLock](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbymembershiplock) | Values representing the state of the lobby's membership lock. | | [PFLobbyOwnerMigrationPolicy](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbyownermigrationpolicy) | The available policies the lobby service can use to migrate lobby ownership between members. | | [PFLobbyServerConnectionStatus](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbyserverconnectionstatus) | Values representing the current status of the Lobby Server's connection status to the notification service. | | [PFLobbyStateChangeType](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/enums/pflobbystatechangetype) | The types of state changes that can occur in the Lobby library. | ## Related topics - [PFMultiplayer C/C++ API 概要 - PFLobby.h](/ja-jp/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md) - [PFMultiplayer C/C++ API 개요 - PFLobby.h](/ko/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md) - [PFMultiplayer C/C++ API 概览 - PFLobby.h](/zh-CN/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md) - [Información general de la API de C/C++ de PFMultiplayer - PFLobby.h](/es/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pflobby/pflobby_members.md) - [PFMultiplayer C/C++ API overview - PFMultiplayer.h](/services/playfab/multiplayer/lobby/playfabmultiplayerreference-cpp/pfmultiplayer/pfmultiplayer_members.md)