lineSetAgentMeasurementPeriod function (tapi.h)
The lineSetAgentMeasurementPeriod function sets the measurement period associated with a particular agent. It generates a LINE_PROXYREQUEST message to be sent to a registered proxy function handler, referencing a LINEPROXYREQUEST structure of type LINEPROXYREQUEST_SETAGENTMEASUREMENTPERIOD.
Syntax
LONG lineSetAgentMeasurementPeriod(
HLINE hLine,
HAGENT hAgent,
DWORD dwMeasurementPeriod
);
Parameters
hLine
Handle to the line device.
hAgent
Identifier of the agent whose information is to be changed.
dwMeasurementPeriod
New measurement period (seconds). Must be greater than zero.
Return value
Returns a request identifier if the asynchronous operation starts; otherwise, the function returns one of the following error values:
LINEERR_INVALLINEHANDLE, LINEERR_INVALPARAM, LINEERR_NOMEM, LINEERR_OPERATIONFAILED, LINEERR_OPERATIONUNAVAIL, LINEERR_RESOURCEUNAVAIL, LINEERR_UNINITIALIZED.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | tapi.h |
| Library | Tapi32.lib |
| DLL | Tapi32.dll |