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.
Configures an optional, custom pointer-sized context value with this lobby object.
Syntax
HRESULT PFLobbySetCustomContext(
PFLobbyHandle lobby,
void* customContext
)
Parameters
lobby PFLobbyHandle
The handle of the lobby.
customContext void*
optional
An arbitrary, pointer-sized value to store with the player object.
Return value
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().
Remarks
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.
Requirements
Header: PFLobby.h