PFLeaderboardsGetLeaderboardDefinitionAsync - XBOX Game Development Documentation

Gets the specified leaderboard definition.

Syntax

HRESULT PFLeaderboardsGetLeaderboardDefinitionAsync(  
    PFEntityHandle entityHandle,  
    const PFLeaderboardsGetLeaderboardDefinitionRequest* request,  
    XAsyncBlock* async  
)  

Parameters

entityHandle PFEntityHandle PFEntityHandle to use for authentication. request PFLeaderboardsGetLeaderboardDefinitionRequest* 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 Windows, Linux, and macOS. See also LeaderboardDeleteLeaderboardDefinitionAsync. When the asynchronous task is complete, call PFLeaderboardsGetLeaderboardDefinitionGetResultSize and PFLeaderboardsGetLeaderboardDefinitionGetResult to get the result.

Requirements

Header: PFLeaderboards.h

See also

PFLeaderboards members

Last modified on August 31, 2026

Related topics

PFLeaderboardsGetLeaderboardDefinitionGetResult Services C API overview - PFLeaderboards.h PFLeaderboardsListLeaderboardDefinitionsAsync PFLeaderboardsDeleteLeaderboardDefinitionAsync PFLeaderboardsUpdateLeaderboardDefinitionAsync

⌘I