XblMultiplayerSessionHostCandidates

Host candidates are an ordered list of device tokens, ordered by preference as specified by XblMultiplayerMetrics in the session constants.

Syntax

HRESULT XblMultiplayerSessionHostCandidates(  
         XblMultiplayerSessionHandle handle,  
         const XblDeviceToken** deviceTokens,  
         size_t* deviceTokensCount  
)  

Parameters

handle   _In_
Type: XblMultiplayerSessionHandle Handle to the multiplayer session. deviceTokens   _Out_
Type: XblDeviceToken** Passes back a pointer to the array of candidate device tokens. The memory for the pointer will remain valid for the life of the XblMultiplayerSessionHandle object until it is closed. deviceTokensCount   _Out_
Type: size_t* Passes back the size of the deviceTokens array.

Return value

Type: HRESULT HRESULT return code for this API operation.

Requirements

Header: multiplayer_c.h Library: Microsoft.Xbox.Services.142.C.lib or Microsoft.Xbox.Services.143.C.lib

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Requirements

See also

​Syntax

​Parameters

​Return value

​Requirements

​See also

Syntax

Parameters

Return value

Requirements

See also