Skip to content
REFERENCE

U.RTD_THROTTLE_MILLIS

Summary

Allows user to set and returns the current Excel instance and/or machine-wide RTD throttle in milliseconds. Also allows user to set a throttle that will slow only the receipt of U reports in the current Excel instance

Syntax

=U.RTD_THROTTLE_MILLIS(throttle, [subscribe_only], [block])

Parameters

Parameter Required Description
throttle Yes The RTD throttle in millis to apply. Min of 25 and max of 60000 is enforced
[subscribe_only] No If set to TRUE then the specified throttle will be applied only to the receipt of U reports in the current instance only. If explicitly set to FALSE then Excel's default RTD throttle is updated in the Windows registry
[block] No If set to TRUE then method will not be calculated unless triggered by user interaction or calculated as a step in a script; If set to a number then will be throttled to not calculate more frequently than the specified number of seconds; make number negative to prevent auto recalc of blocked methods

Behavior

The documented public interface is supported by the current U Add-in source signature and the maintained Usage Examples workbook. Optional parameters are shown in square brackets in the syntax above; omit the brackets when entering a formula.

Return Value

With no throttle argument, returns the current throttle interval. When setting a throttle, returns the status of the RTD or Runline-subscription throttle change.

Examples

=U.RTD_THROTTLE_MILLIS()

Notes

  • Formula examples are preserved from maintained workbook usage and normalized to the current U. prefix.
  • Complete formulas demonstrate working patterns; they do not imply that undocumented option values are supported.
  • Where maintained sources do not specify every accepted value, default, or error message, this page does not infer one.
  • For functions that perform actions, use a visible trigger or supported block/throttle parameter to avoid unintended repetition during recalculation.