PFSegmentsServerGetAllSegmentsAsync - XBOX Game Development Documentation

Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment 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 Win32, Linux, and macOS. Request has no parameters. See also ServerGetPlayersInSegmentAsync. 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 August 3, 2026

Related topics

PFSegmentsServerGetAllSegmentsGetResult Services C API overview - PFSegments.h PFSegmentsServerGetPlayersInSegmentAsync PFSegmentsServerGetPlayerSegmentsAsync PFSegmentsServerGetAllSegmentsGetResultSize

⌘I