Share via


XboxLiveQualityOfServiceMeasurement.GetMetricResultsForMetric Method

Definition

Gets the most recent values of a given metric, across all devices being measured.

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 GetMetricResultsForMetric at any time while measurements are in progress or after they have finished, and retrieve current values. Note that if you repeatedly call GetMetricResultsForMetric. and inspect a given metric for a particular device 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 IVectorView<XboxLiveQualityOfServiceMetricResult ^> ^ GetMetricResultsForMetric(XboxLiveQualityOfServiceMetric metric) = GetMetricResultsForMetric;
IVectorView<XboxLiveQualityOfServiceMetricResult> GetMetricResultsForMetric(XboxLiveQualityOfServiceMetric const& metric);
public IReadOnlyList<XboxLiveQualityOfServiceMetricResult> GetMetricResultsForMetric(XboxLiveQualityOfServiceMetric metric);
function getMetricResultsForMetric(metric)
Public Function GetMetricResultsForMetric (metric As XboxLiveQualityOfServiceMetric) As IReadOnlyList(Of XboxLiveQualityOfServiceMetricResult)

Parameters

metric
XboxLiveQualityOfServiceMetric

The metric to be retrieved.

Returns

A list of metric values for all devices being measured.

Applies to