Skip to content
REFERENCE

U.BACKUP_ALL_WORKBOOKS

Summary

Enables or disables backups for all workbooks

Syntax

=U.BACKUP_ALL_WORKBOOKS(enable, [schedule], [save_current], [max_megabytes], [backups_top_dir])

Parameters

Parameter Required Description
enable Yes Set to TRUE to enable backing up all workbooks. Set to FALSE to disable backing up all workbooks. If not set a report of the current default backup schedule, if backup all is enabled, is returned
[schedule] No The schedule for the backups with each row containing an interval (minutes, hours or days), a frequency to save backups, and the duration for which the frequency is applicable; default schedule used if not set
[save_current] No Set to TRUE to have the current workbook saved each time it is backed up. By default the backup will have all current changes, but the current workbook itself is not saved
[max_megabytes] No The maximum size of the backup directory. Oldest files are removed until the size is below this limit. Default is 250 MB per workbook-specific subdirectory if not set
[backups_top_dir] No The top-level directly in which a workbook-specific subdirectory with backups will be saved. Default is C:\Runline\Backups if not provided

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

Returns the function result or action status described by the formula and parameters above. The maintained sources do not define a narrower, stable return contract for this function.

Examples

=U.BACKUP_ALL_WORKBOOKS(TRUE)

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.