Edit

Share via

ITAgent::put_MeasurementPeriod method (tapi3cc.h)

  • Article

The put_MeasurementPeriod method sets the period (in seconds) for which the switch and/or implementation stores and calculates information. This also resets any cumulative counts to zero.

Syntax

HRESULT put_MeasurementPeriod(
  [in] long lPeriod
);

Parameters

[in] lPeriod

Measurement period (in seconds).

Return value

This method can return one of these values.

Return code Description
S_OK
 Method succeeded.
E_INVALIDARG
 Value of lPeriod is zero.
E_OUTOFMEMORY
 Insufficient memory exists to perform the operation.
LINEERR_
 See lineSetAgentMeasurementPeriod for error codes returned from this TAPI 2.1 function.

Remarks

The ITAgent::put_MeasurementPeriod method is a COM wrapper for the TAPI 2.1 lineSetAgentMeasurementPeriod function.

This method will accept negative values for the measurement period, but this will normally result in unreliable statistics.

Requirements

Requirement Value
Target Platform Windows
Header tapi3cc.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

ITAgent

get_MeasurementPeriod