XblMultiplayerSessionSetServerConnectionStringCandidates

The ordered list of case-insensitive connection strings that the session could use to connect to a game server. Generally titles should use the first on the list, but sophisticated titles could use a custom mechanism for choosing one of the others (e.g. based on load).

Syntax

HRESULT XblMultiplayerSessionSetServerConnectionStringCandidates(  
         XblMultiplayerSessionHandle handle,  
         const char** serverConnectionStringCandidates,  
         size_t serverConnectionStringCandidatesCount  
)  

Parameters

handle   _In_
Type: XblMultiplayerSessionHandle Handle to the multiplayer session. serverConnectionStringCandidates   _In_reads_(serverConnectionStringCandidatesCount)
Type: char** The collection of connection paths. serverConnectionStringCandidatesCount   _In_
Type: size_t The size of the candidates 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