Skip to main content

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

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.14x.GDK.C.lib

See also

multiplayer_c
Last modified on August 4, 2026