Edit

PFLobbyServerPostUpdate

  • Article

Post an update to the lobby as the server-owner.

Syntax

HRESULT PFLobbyServerPostUpdate(  
    PFLobbyHandle lobby,  
    const PFLobbyDataUpdate* lobbyUpdate,  
    void* asyncContext  
)

Parameters

lobby   PFLobbyHandle

The handle of the lobby.

lobbyUpdate   PFLobbyDataUpdate*

An update to apply to the shared portion of the lobby on behalf of the server owner.

asyncContext   void*
optional

An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.

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

To use this feature, you must define PFMULTIPLAYER_INCLUDE_SERVER_APIS before including PFLobby.h.

This is an asynchronous operation. Upon successful completion, the title will be provided a PFLobbyServerPostUpdateCompletedStateChange with the PFLobbyServerPostUpdateCompletedStateChange::result field set to S_OK. Upon a failed completion, the title will be provided a PFLobbyServerPostUpdateCompletedStateChange with the PFLobbyServerPostUpdateCompletedStateChange::result field set to a failure. If applying the update would change the state of the lobby, the title will be provided a PFLobbyUpdatedStateChange sometime afterwards.

This operation completing successfully only indicates that the Lobby service has accepted the update. The title's local view of the Lobby state will not reflect this update until a PFLobbyUpdatedStateChange is provided to the title with the updated state.

Requirements

Header: PFLobby.h

See also

PFLobby members
PFLobbyPostUpdate