Function Entry: VLAX-GET-OBJECT

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

Function Entry: VLAX-GET-OBJECT

Name

vlax-get-object

Class

Visual LISP automation locator

Syntax

(vlax-get-object prog-id)

Arguments and Values

  • prog-id — string naming an automation class.

The documented format is: 

appname.objecttype[.version]

Description

Returns a running instance of an application automation object.

Return Values

Returns a VLA-object if a matching running object exists; otherwise returns nil.

Exceptional Situations

Signals an AutoLISP-visible error if the underlying automation layer fails.

Notes

  • Autodesk documents this as available only in AutoCAD for Windows, not in AutoCAD LT for Windows, nor on macOS or Web.
  • This is the non-creating counterpart of vlax-create-object.

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.