PFSegmentsServerGetPlayerSegmentsAsync - XBOX Game Development Documentation

List all segments that a player currently belongs to at this moment in time.

Syntax

HRESULT PFSegmentsServerGetPlayerSegmentsAsync(  
    PFEntityHandle titleEntityHandle,  
    const PFSegmentsGetPlayersSegmentsRequest* request,  
    XAsyncBlock* async  
)  

Parameters

titleEntityHandle PFEntityHandle PFEntityHandle for a title Entity obtained using PFAuthenticationGetEntityWithSecretKeyAsync. request PFSegmentsGetPlayersSegmentsRequest* 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. See also ServerGetAllSegmentsAsync. When the asynchronous task is complete, call PFSegmentsServerGetPlayerSegmentsGetResultSize and PFSegmentsServerGetPlayerSegmentsGetResult to get the result.

Requirements

Header: PFSegments.h

See also

PFSegments members

Last modified on August 3, 2026

Related topics

PFSegmentsServerGetPlayerSegmentsGetResult Services C API overview - PFSegments.h PFSegmentsServerGetPlayersInSegmentAsync PFSegmentsServerGetAllSegmentsAsync PFSegmentsServerGetPlayersInSegmentGetResult

⌘I