PFAuthenticationAuthenticateGameServerWithCustomIdAsync - XBOX Game Development Documentation

Create a game_server entity token and return a new or existing game_server entity.

Syntax

HRESULT PFAuthenticationAuthenticateGameServerWithCustomIdAsync(  
    PFEntityHandle entityHandle,  
    const PFAuthenticationAuthenticateCustomIdRequest* request,  
    XAsyncBlock* async  
)  

Parameters

entityHandle PFEntityHandle PFEntityHandle to use for authentication. request PFAuthenticationAuthenticateCustomIdRequest* 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. Create or return a game_server entity token. Caller must be a title entity. When the asynchronous task is complete, call PFAuthenticationAuthenticateGameServerWithCustomIdGetResultSize and PFAuthenticationAuthenticateGameServerWithCustomIdGetResult to get the result.

Requirements

Header: PFAuthentication.h

See also

PFAuthentication members

Last modified on August 1, 2026

Related topics

PFAuthenticationAuthenticateGameServerWithCustomIdGetResult Services C API overview - PFAuthentication.h PFAuthenticationServerLoginWithServerCustomIdAsync PFAuthenticationAuthenticateCustomIdRequest PFAuthenticationAuthenticateCustomIdResult

⌘I