PFSegmentsServerGetAllSegmentsAsync - XBOX Game Development Documentation

Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.

Syntax

HRESULT PFSegmentsServerGetAllSegmentsAsync(  
    PFEntityHandle titleEntityHandle,  
    XAsyncBlock* async  
)  

Parameters

titleEntityHandle PFEntityHandle PFEntityHandle for a title Entity obtained using PFAuthenticationGetEntityWithSecretKeyAsync. 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. Request has no paramaters. See also ServerExportPlayersInSegmentAsync, ServerGetSegmentExportAsync. When the asynchronous task is complete, call PFSegmentsServerGetAllSegmentsGetResultSize and PFSegmentsServerGetAllSegmentsGetResult to get the result.

Requirements

Header: PFSegments.h

See also

PFSegments members

Last modified on October 20, 2026

⌘I