Edit

Share via

PFAuthenticationServerLoginWithXboxIdAsync

  • Article

Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Syntax

HRESULT PFAuthenticationServerLoginWithXboxIdAsync(  
    PFServiceConfigHandle serviceConfigHandle,  
    const char* secretKey,  
    const PFAuthenticationLoginWithXboxIdRequest* request,  
    XAsyncBlock* async  
)

Parameters

serviceConfigHandle   PFServiceConfigHandle

PFServiceConfigHandle returned from PFServiceConfigCreateHandle call.

secretKey   char*
In_z

Title Secret Key used to authenticate the service request.

request   PFAuthenticationLoginWithXboxIdRequest*

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 Win32, Linux, and macOS. If this is the first time a user has signed in with the Xbox ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Xbox Live account. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Xbox Live account, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account. When the asynchronous task is complete, call PFAuthenticationServerLoginWithXboxIdGetResult to get the result.

Requirements

Header: PFAuthentication.h

See also

PFAuthentication members