Function Entry: VLAX-LDATA-GET

vlax-ldata-get

Visual LISP persistent-data accessor

(vlax-ldata-get dictionary key [default [private]])

• dictionary — dictionary or object designator supporting ldata.
• key — string naming the ldata key.
• default — default value returned if the key is absent.
• private — privacy selector in Autodesk's ldata protocol.

Autodesk documents:

• dictionary as either a VLA-object or a string naming a global dictionary
• default as one of integer, real, string, list, ename, VLA-object, variant, safearray, T, or nil
• private as T or nil

Retrieves persistent AutoLISP data associated with a dictionary or object.

Returns the stored value if present; otherwise returns default if supplied, or nil.

Signals an AutoLISP-visible error if the target does not support ldata access.

• If private is non-nil and the call originates from a separate-namespace VLX, Autodesk documents that private ldata is read instead of public ldata.
• If private is supplied, Autodesk requires that default also be supplied, though default may itself be nil.
• Autodesk explicitly notes that the same dict and key can hold both private and non-private data.

• AutoCAD 2026: documented (per Autodesk reference page).
• BricsCAD V26: presumed compatible (no contradicting page found).
• Status: AutoCAD documented; BricsCAD presumed-both pending Phase 4 verification.

• [vlax-ldata-get (AutoLISP/ActiveX)](https://help.autodesk.com/cloudhelp/2023/JPN/AutoCAD-AutoLISP-Reference/files/GUID-C279216F-9568-4176-A9E7-BCB45E3F59C7.htm)

Available on Windows only; not available on macOS or Web.