Function Entry: LAYERSTATE-RESTORE

← Prev | ↑ Chapter | Next → | Index | Symbols

Function Entry: LAYERSTATE-RESTORE

Name

layerstate-restore

Class

Layer-State Function

Syntax

(layerstate-restore layerstatename viewport [restoreflags])

Arguments and Values

  • layerstatename: string.
  • viewport: ename of a viewport, or nil for model space.
  • restoreflags (optional): integer; sum of:
    • 1: turn off all layers not in the restored state.
    • 2: freeze all layers not in the restored state.
    • 4: apply the layer state as viewport overrides (requires non-nil viewport).

Description

Applies a saved layer state to the current drawing.

Return Values

A list of layer names if successful, or nil if the layer state does not exist or contains no layers.

Side Effects

Mutates the per-layer visibility / property settings, or applies viewport overrides.

Examples

  • (layerstate-restore "myLayerState" viewportId 5).

Availability

  • AutoCAD 2026: documented (Windows, macOS only).
  • BricsCAD V26: parallel function is vl-layerstates-restore (chapter 24).
  • Status: AutoCAD-named family with BricsCAD divergence — see Phase 4 reconciliation.

See Also

  • BricsCAD analogue: vl-layerstates-restore (chapter 24).
  • Family pair documented in vendor-inventory-2026.org §10 item 6.

Source Notes