nn::nex::PHBDRParameters::SetConvergenceDelay Member Function

Syntax

qBool SetConvergenceDelay(
     TimeInterval tiMinCPDelay,
     TimeInterval tiMaxCPDelay
);

Parameters

Name Description
in tiMinCPDelay Specifies the minimum convergence delay in milliseconds. The default value is 250.
in tiMaxCPDelay Specifies the maximum convergence delay in milliseconds. The default value is 1000.

Return Values

Returns whether the setting was successful.
Returns false and signals SYSTEMERROR_GEN_OUT_OF_RANGE if tiMinCPDelay or tiMaxCPDelay are equal to or less than 0 or if tiMaxCPDelay is less than tiMinCPDelay.

Description

Sets the minimum and maximum delay used by the convergence algorithm.

Revision History

2012/08/31
Initial version.

CONFIDENTIAL