| author | title | description | ms.author | ms.topic | ms.service | ms.date |
|---|---|---|---|---|---|---|
ScottMunroMS |
PFLobbySetCustomContext |
Configures an optional, custom pointer-sized context value with this lobby object. |
scmunro |
reference |
playfab |
01/03/2022 |
Configures an optional, custom pointer-sized context value with this lobby object.
HRESULT PFLobbySetCustomContext(
PFLobbyHandle lobby,
void* customContext
) lobby PFLobbyHandle
The handle of the lobby.
customContext void*
optional
An arbitrary, pointer-sized value to store with the player object.
Type: HRESULT
S_OK if configuring the custom context succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PFMultiplayerGetErrorMessage().
The custom context is typically used as a "shortcut" that simplifies accessing local, title-specific memory associated with the lobby without requiring a mapping lookup. The value is retrieved using the PFLobbyGetCustomContext() method.
Any configured value is treated as opaque by the library, and is only valid on the local device; it is not transmitted over the network.
Header: PFLobby.h