vlaxgetproperty

vlax-get-property is a Visual LISP function used in AutoCAD and other products that support Visual LISP's ActiveX automation interface. It retrieves the value of a property from a COM/Automation object. The function is part of the vlax family, which provides access to COM objects, properties, and methods from Lisp code.

Syntax: (vlax-get-property obj prop) where obj is a COM object reference (for example, one obtained with vlax-create-object or vlax-get-acad-object) and prop is the property name, supplied as a symbol or string. For nested properties, call vlax-get-property on the result of a previous call.

Examples:

(setq acad (vlax-get-acad-object))

(setq activeDoc (vlax-get-property acad 'ActiveDocument))

(setq modelSpace (vlax-get-property activeDoc 'ModelSpace))

Return value: The property value is returned as a Lisp representation or as a wrapper for a COM object if the property is an object. If the property does not exist or is not readable, an error is signaled.

Notes and related functions: vlax-put-property is used to assign a value to a property, and vlax-invoke is used to call methods on COM objects. vlax-get-property is commonly used in combination with error handling constructs such as vl-catch-all to gracefully handle inaccessible or non-existent properties. The exact behavior and types of returned values depend on the host application's object model and the specific property accessed.