author | title | description | ms.author | ms.topic | ms.service | ms.date |
---|---|---|---|---|---|---|
ScottMunroMS |
PFLobbyGetMembers |
Gets the list of PlayFab entities currently joined to the lobby as members. |
scmunro |
reference |
playfab |
03/07/2023 |
Gets the list of PlayFab entities currently joined to the lobby as members.
HRESULT PFLobbyGetMembers(
PFLobbyHandle lobby,
uint32_t* memberCount,
const PFEntityKey** members
)
lobby
PFLobbyHandle
The handle of the lobby.
memberCount
uint32_t*
output
The output member count.
members
PFEntityKey**
library-allocated output array of size *memberCount
The output member array.
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().
If this lobby object is still in the process of asynchronously being created, joined, or claimed, via a call to PFMultiplayerCreateAndJoinLobby(), PFMultiplayerJoinLobby(), PFMultiplayerCreateAndClaimServerLobby(), or PFMultiplayerClaimServerLobby(), this method will return no members.
If this lobby is server-owned, the owning game_server entity will not be returned in this list of members.
Header: PFLobby.h