XNetworkingGetConnectivityHint

Article
06/22/2023

Queries for device-wide information about the current network connectivity level, data limits, interface type, and network initialization state.

Syntax

HRESULT XNetworkingGetConnectivityHint(
         XNetworkingConnectivityHint* connectivityHint
)

Parameters

connectivityHint _Out_
Type: XNetworkingConnectivityHint*

The current device-wide state of the network.

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

This function returns device-wide information about the network connectivity level, data limits, wired vs. wireless connectivity, and whether the network is initialized. You can listen for changes with the XNetworkingRegisterConnectivityHintChanged and XNetworkingUnregisterConnectivityHintChanged functions.

The fields in the returned XNetworkingConnectivityHint structure (except the XNetworkingConnectivityHint::networkInitialized field) are hints. They are best-effort guesses by the device about the current state of the network based on a summary of the network traffic on the device. Importantly, these fields do not represent whether there is connectivity to your specific title endpoints. We recommend that, after waiting for network initialization, you use WinSock and/or WinHTTP to try to establish a connection to your endpoint regardless of the state of the XNetworkingConnectivityHint::connectivityLevelHint field. If those APIs subsequently fail, we recommend that you then use the XNetworkingGetConnectivityHint API for additional UI and diagnostic reporting purposes. You should then wait for a change in the network connectivity level before trying again.

For more information about network initialization, see Network Initialization & Connectivity.

This method interrogates the local state within the calling process and returns quickly, so it is safe to call from time-sensitive contexts.

Requirements

Header: XNetworking.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

Share via