Skip to main content
Retrieves the title-specific custom data for the user which is readable and writable by the client

Syntax

Parameters

entityHandle   PFEntityHandle PFEntityHandle to use for authentication. request   PFPlayerDataManagementGetUserDataRequest* 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. Data is stored as JSON key-value pairs. Every time the data is updated via any source, the version counter is incremented. If the Version parameter is provided, then this call will only return data if the current version on the system is greater than the value provided. If the Keys parameter is provided, the data object returned will only contain the data specific to the indicated Keys. Otherwise, the full set of custom user data will be returned. See also ClientGetUserReadOnlyDataAsync, ClientUpdateUserDataAsync. When the asynchronous task is complete, call PFPlayerDataManagementClientGetUserDataGetResultSize and PFPlayerDataManagementClientGetUserDataGetResult to get the result.

Requirements

Header: PFPlayerDataManagement.h

See also

PFPlayerDataManagement members
Last modified on August 3, 2026