Function Entry: VLAX-GET-PROPERTY

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

Function Entry: VLAX-GET-PROPERTY

Name

vlax-get-property

Class

Visual LISP Property Function

Syntax

(vlax-get-property obj property [index ...])

Arguments and Values

  • obj: automation object
  • property: property designator
  • optional index arguments for indexed properties

Description

Returns the value of a property on an automation object.

Return Values

Property value in the appropriate AutoLISP/Visual LISP representation, possibly including VARIANT, SAFEARRAY, scalar, string, or object values.

Side Effects

None beyond object-model access.

Notes

Autodesk documents that this function was formerly named vlax-get.

Exceptional Situations

Erroneous if the property does not exist, is inaccessible, or the automation layer is unavailable.

Compatibility

Core part of the ActiveX/VLA property access model.

Measured: Boolean properties

probe-triage3, 2026-10-05: (vlax-get layer 'LayerOn) returns the INTEGER -1 (VARIANTTRUE) on BricsCAD V25 and V26, where vla-get-layeron / vlax-get-property return the symbol :vlax-true. (vlax-put line 'Visible 0) is taken by V25 Windows and refused (Automation Error EINVALIDARG) by V26 macOS.

clautolisp

A Boolean property reads as -1 / 0 through vlax-get and as :vlax-true / :vlax-false through vla-get-* and vlax-get-property.

Availability

  • 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.