Share via


XboxLiveQualityOfServiceMeasurement.GetMetricResult Method

Definition

Gets the results of the most recent measurement of a given metric on the connection to a given address.

Your code specifies a set of metrics, device addresses, timeouts, and number of probes to attempt, and then calls XboxLiveQualityOfServiceMeasurement.MeasureAsync to begin making the specified measurements. You can call GetMetricResult at any time while measurements are in progress or after they have finished, and retrieve its current value. Note that if you repeatedly call GetMetricResult for a given metric while the relevant measurements are in progress, you might get different values as the measurement proceeds.

Important

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

public:
 virtual XboxLiveQualityOfServiceMetricResult ^ GetMetricResult(XboxLiveDeviceAddress ^ deviceAddress, XboxLiveQualityOfServiceMetric metric) = GetMetricResult;
XboxLiveQualityOfServiceMetricResult GetMetricResult(XboxLiveDeviceAddress const& deviceAddress, XboxLiveQualityOfServiceMetric const& metric);
public XboxLiveQualityOfServiceMetricResult GetMetricResult(XboxLiveDeviceAddress deviceAddress, XboxLiveQualityOfServiceMetric metric);
function getMetricResult(deviceAddress, metric)
Public Function GetMetricResult (deviceAddress As XboxLiveDeviceAddress, metric As XboxLiveQualityOfServiceMetric) As XboxLiveQualityOfServiceMetricResult

Parameters

deviceAddress
XboxLiveDeviceAddress

The target address of the measurement.

metric
XboxLiveQualityOfServiceMetric

The metric value to retrieve.

Returns

The result of the measurement.

Applies to