PartyManager::GetRegions

Ruft ein Array ab, das die Gruppe von Regionen enthält, für die Ihr Titel konfiguriert ist, sowie Informationen zur Roundtriplatenz.

Syntax

PartyError GetRegions(  
    uint32_t* regionCount,  
    const PartyRegion** regions  
)  

Parameter

regionCount uint32_t*
Ausgabe

Die Ausgabeanzahl der in regionsbereitgestellten Regionen.

regions PartyRegion**
Von der Bibliothek zugewiesenes Ausgabearray der Größe *regionCount

Ein von der Bibliothek zugeordnetes Ausgabearray, das den Satz von Regionen enthält.

Rückgabewert

PartyError

c_partyErrorSuccess , wenn der Aufruf erfolgreich war oder andernfalls ein Fehlercode vorliegt. Die lesbare Form des Fehlercodes kann über GetErrorMessage() abgerufen werden.

Hinweise

Das von dieser Methode bereitgestellte Array wird erst aufgefüllt, wenn das erste PartyRegionsChangedStateChange bereitgestellt wird. Jede nachfolgende PartyRegionsChangedStateChange gibt eine Aktualisierung dieser Gruppe von Regionen an. Hintergrundvorgänge, die diesen Satz auffüllen, beginnen, wenn Initialize() aufgerufen wird, es sei denn, die Option PartyOption::RegionUpdateConfiguration wurde verwendet, um einen Updatemodus von PartyRegionUpdateMode::D eferred zu konfigurieren. Der verzögerte Modus bedeutet, dass der Abruf von Regionen und die Messung der Verbindungsqualität erst beginnen, wenn die Anwendung CreateNewNetwork() mit einem Nulleingabebereichsarray aufruft oder mit keinem Netzwerk verbunden ist und PartyLocalChatControl:::PSetTranscriptionOptions() mit Optionsflags aufruft, die enthalten PartyVoiceChatTranscriptionOptions::TranscribeSelfRegardlessOfNetworkState. Die Option PartyOption::RegionUpdateConfiguration kann auch verwendet werden, um das Intervall zu konfigurieren, nach dem das Regionsarray aktualisiert werden soll.

Das zurückgegebene Array wird in der Reihenfolge der zunehmenden Latenz sortiert. Latenz für eine Region ist definiert als die End-to-End-Zeit, die benötigt wird, um ein UDP-Datagramm an das PlayFab Quality of Service-Beacon der Region zu senden und eine Antwort zu erhalten. Die Bibliothek misst die Latenz für jede Region mehrmals, um Ergebnisse mit hoher Genauigkeit zu berechnen. Anwendungen können low-level-Aspekte dieses Verbindungsqualitätsmessungsverfahrens mithilfe der Option PartyOption::RegionQualityMeasurementConfiguration ändern.

Eine Latenz, die UINT32_MAX entspricht, gibt an, dass die Region unterstützt wird, latenzinformationen jedoch nicht ermittelt werden konnten, entweder aufgrund von Fehlern innerhalb der Bibliothek oder aufgrund eines Timeouts, ohne dass eine Antwort vom Beacon empfangen wurde. Dies kann zu Diagnosezwecken verwendet werden (eine UINT32_MAX Latenz für jede Region deutet wahrscheinlich auf ein lokales Konfigurationsproblem hin) oder zum Herausfiltern von Regionen, die bei der Regionsauswahl wahrscheinlich nicht praktikabel sind.

Die zurückgegebenen Namen in den PartyRegion-Strukturen sind nicht in der Sprache des aktuellen Benutzers lokalisiert, und das Direkte Anzeigen der Zeichenfolgen in der Benutzeroberfläche wird außerhalb der Problembehandlung nicht empfohlen.

Gehen Sie nicht davon aus, dass die zurückgegebenen Regionen während der Lebensdauer Ihres Titels gleich bleiben. Die PlayFab Party-Bibliothek nutzt im Laufe der Zeit automatisch Ergänzungen und Änderungen an verfügbaren Regionen, um die Erfahrung für Endbenutzer kontinuierlich zu verbessern.

Voraussetzungen

Header: Party.h

Weitere Informationen

PartyManager
PartyRegionsChangedStateChange
PartyManager::CreateNewNetwork