Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Retrieves the specified networking statistics into a caller provided buffer.
Syntax
HRESULT XNetworkingQueryStatistics(
XNetworkingStatisticsType statisticsType,
XNetworkingStatisticsBuffer* statisticsBuffer
)
Parameters
statisticsType _In_
Type: XNetworkingStatisticsType
The enumerated value identifying the particular statistics to be retrieved.
statisticsBuffer _Out_
Type: XNetworkingStatisticsBuffer
A pointer to a caller-provided structure into which the requested statistics will be written. The exact sub-structure field within the union buffer that is written depends on the requested type of statistics.
Return value
Type: HRESULT
S_OK if retrieving the statistics was successful. E_NOTIMPL if retrieving the specified statistics type isn't supported on the current platform. E_INVALIDARG if the specified statistics type isn't recognized by the Gaming Runtime.
Remarks
This function retrieves a snapshot of the specified networking-related statistics into the caller-provided buffer. Note that most statistics are not guaranteed to report the same value across multiple calls to this function.
Only the statistics-specific substructure field within the output buffer union will be written. Any additional memory in the caller's output buffer that is defined by the union as a whole but that lies beyond the end of the substructure is not modified in any way by this function.
Requirements
Header: XNetworking.h
Library: xgameruntime.lib
Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles