PFTitleDataManagementServerGetTitleDataAsync - XBOX Game Development Documentation

Retrieves the key-value store of custom title settings

Syntax

HRESULT PFTitleDataManagementServerGetTitleDataAsync(  
    PFEntityHandle titleEntityHandle,  
    const PFTitleDataManagementGetTitleDataRequest* request,  
    XAsyncBlock* async  
)  

Parameters

titleEntityHandle PFEntityHandle PFEntityHandle for a title Entity obtained using PFAuthenticationGetEntityWithSecretKeyAsync. request PFTitleDataManagementGetTitleDataRequest* 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. This API is designed to return title specific values which can be read, but not written to, by the client. For example, a developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. If an override label is specified in the request, the overrides are applied automatically and returned with the title data. Note that there may up to a minute delay in between updating title data and this API call returning the newest value. See also ServerSetTitleDataAsync. When the asynchronous task is complete, call PFTitleDataManagementServerGetTitleDataGetResultSize and PFTitleDataManagementServerGetTitleDataGetResult to get the result.

Requirements

Header: PFTitleDataManagement.h

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

Syntax

Parameters

Return value

Remarks

Requirements

See also