PFMultiplayerServerRequestMultiplayerServerAsync

Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client to request a server with player entity token.

Syntax

HRESULT PFMultiplayerServerRequestMultiplayerServerAsync(  
    PFEntityHandle entityHandle,  
    const PFMultiplayerServerRequestMultiplayerServerRequest* request,  
    XAsyncBlock* async  
)  

Parameters

entityHandle PFEntityHandle PFEntityHandle to use for authentication. request PFMultiplayerServerRequestMultiplayerServerRequest* Populated request object. async XAsyncBlock*
Inout XAsyncBlock for the async operation.

Return value

Type: HRESULT Result code for this API operation.

Remarks

This API is available on all platforms. Requests a multiplayer server session from a particular build in any of the given preferred regions. See also MultiplayerServerGetMultiplayerServerDetailsAsync. When the asynchronous task is complete, call PFMultiplayerServerRequestMultiplayerServerGetResultSize and PFMultiplayerServerRequestMultiplayerServerGetResult to get the result.

Requirements

Header: PFMultiplayerServer.h

PlayFab API

PlayFab REST API References

Supplemental pages

Syntax

Parameters

Return value

Remarks

Requirements

See also

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

Syntax

Parameters

Return value

Remarks

Requirements

See also