Visual LISP Function

Visual LISP Extensions

to AutoLISP®
Before using the AutoLISP extensions, issue the
following command: (vl-load-com)
The vl-load-com function also initializes ActiveX™
support for AutoLISP
Reference Chart
Collection Manipulation Functions

(vlax-for symbol collection [expression1 [expression2 ...]])

(vlax-map-collection obj function)
AutoLISP Functions
Basic Functions
Arithmetic Symbol-Handling Functions
Curve Measurement Functions (+ [number number] ...) (float number) (atom item) (read [string])
(- [number number] ...) (gcd int1 int2) (atoms-family format [symlist]) (set sym expr)
(* [number number] ...) (log number) (boundp sym) (setq sym1 expr1 [sym2 expr2] ...)
(vlax-curve-getArea curve-obj) (/ [number number] ...) (logand int int ...) (not item) (type item)
(vlax-curve-getDistAtParam curve-obj param) (~ int) (logior int int ...) (null item) (vl-symbol-name symbol)
(vlax-curve-getDistAtPoint curve-obj point) (1+ number) (lsh int numbits) (numberp item) (vl-symbol-value symbol)
(vlax-curve-getEndParam curve-obj) (1- number) (max number number ...) (quote expr) (vl-symbolp object)
(vlax-curve-getEndPoint curve-obj) (abs number) (min number number ...)
(vlax-curve-getParamAtDist curve-obj param) (atan num1 [num2]) (minusp number)
(vlax-curve-getParamAtPoint curve-obj point) (cos ang) (rem num1 num2 ...)
List Manipulation Functions
(vlax-curve-getPointAtDist curve-obj dist) (exp number) (sin ang) (acad_strlsort lst) (vl-consp list-variable)
(vlax-curve-getPointAtParam curve-obj param) (expt base power) (sqrt number) (append lst ...) (vl-every predicate-function list [more-lists]...)
(vlax-curve-getStartParam curve-obj) (fix number) (zerop number) (assoc item alist) (vl-list* object [more-objects]...)
(vlax-curve-getStartPoint curve-obj) (car lst) and (cdr lst) (vl-list->string char-codes-list)
(vlax-curve-isClosed curve-obj) String-Handling Functions (cons new-first-element lst) (vl-list-length list-or-cons-object)
(vlax-curve-isPeriodic curve-obj) (foreach name lst expr ...) (vl-member-if predicate-function list)
(vlax-curve-isPlanar curve-obj) (strcase string [which]) (vl-string-position char-code str [start-pos [from-end-p]]) (last lst) (vl-member-if-not predicate-function list)
(vlax-curve-getClosestPointTo curve-obj givenPnt [extend]) (strcat string1 [string2] ...) (vl-string-right-trim character-set string) (length lst) (vl-position symbol list)
(vlax-curve-getClosestPointToProjection (strlen [string] ...) (vl-string-search pattern string [start-pos]) (list expr ...) (vl-remove element-to-remove list)
curve-obj givenPnt normal [extend]) (substr string start [length]) (vl-string-subst new-str pattern string [start-pos]) (listp item) (vl-remove-if predicate-function list)
(vlax-curve-getFirstDeriv curve-obj param) (vl-prin1-to-string object) (vl-string-translate source-set dest-set str) (mapcar function list1 ... listn) (vl-remove-if-not predicate-function list)
(vlax-curve-getSecondDeriv curve-obj param) (vl-princ-to-string object) (vl-string-trim char-set str) (member expr lst) (vl-some predicate-function list [more-lists]...)
(vl-string-elt string position) (vl-string->list string) (nth n lst) (vl-sort list less?-function)
(vl-string-left-trim character-set string) (wcmatch string pattern) (reverse lst) (vl-sort-i list less?-function)
(vl-string-mismatch str1 str2 [pos1 pos2 ignore-case-p])
Data Conversion Functions (subst newitem olditem lst) (vl-string->list string)

Equality & Conditional Functions

(vlax-3D-point list) Function-Handling Functions
(vlax-3D-point x y [z]) (= numstr [numstr] ...) (cond (test1 result1 ...) ...)
(/= numstr [numstr] ...) (eq expr1 expr2) (apply function lst) (trace function ...)
(vlax-ename->vla-object entname)
(< numstr [numstr] ...) (equal expr1 expr2 [fuzz]) (defun sym argument-list expr ...) (untrace function ...)
(vlax-make-variant value type)
(<= numstr [numstr] ...) (if testexpr thenexpr [elseexpr]) (eval expr) (defun-q sym [arguments] [/variables...] expr ...)
(vlax-safearray-fill var 'element-values)
(> numstr [numstr] ...) (or expr ...) (lambda arguments expr ...) (defun-q-list-ref 'function)
(vlax-safearray-get-dim var)
(>= numstr [numstr] ...) (repeat int expr ...) (progn [expr] ...) (defun-q-list-set 'sym)
(vlax-safearray-get-element var element)
(vlax-safearray-get-l-bound var dim) (and expr ...) (while testexpr expr ...)
(vlax-safearray-get-u-bound var dim) (Boole func int1 int2 ...) Application-Handling Functions
(vlax-safearray-put-element var element value)
(vlax-safearray-type var) Error-Handling Functions (ads) (autoxload filename cmdlist)
(vlax-safearray->list var) (arx) (load filename [onfailure])
(vlax-tmatrix list) (alert string) (vl-catch-all-apply 'function list) (arxload application [onfailure]) (startapp appcmd file)
(vlax-variant-change-type var type) (*error* string) (vl-catch-all-error-message error-obj) (arxunload application [onfailure]) (vl-vbaload "filename")
(vlax-variant-type var) (exit) (vl-catch-all-error-p arg) (autoarxload filename cmdlist) (vl-vbarun "macroname")
(vlax-variant-value var) (quit) (autoload filename cmdlist) (vlax-add-cmd "global-name 'func-sym ["local--name" cmd-flags])
(vlax-vla-object->ename obj)

Dictionary Functions Utility Functions Memory Management Functions

Query & Command Functions File-Handling Functions Memory Management Functions
(vlax-ldata-delete dict key)
(vlax-ldata-get dict key [default-data]) (acad_colordlg colornum [flag]) (setenv varname) (close file-desc) (vl-file-rename "old-filename" (alloc int) (gc)
(vlax-ldata-list dict) (acad_helpdlg helpfile topic) (setfunhelp function [helpfile (findfile filename) "new-filename") (expand number) (mem)
(vlax-ldata-put dict key data) (command [arguments] ...) [topic [command]]]) (open filename mode) (vl-file-size "filename")
(vlax-ldata-test data) (getcfg cfgname) (setvar varname value) (read-char [file-desc]) (vl-file-systime "filename")
(getcname cname) (ver) (read-line [file-desc]) (vl-filename-base "filename")
(getenv variable-name) (vl-cmdf [arguments] ...) (vl-directory-files (vl-filename-directory "filename") Reactor Functions
(getvar varname) (vlax-add-cmd global-name [directory pattern directories]) (vl-filename-extension "filename") Reactor Functions
Method Invocation Functions (help [helpfile [topic [command]]]) func-sym [local-name cmd-flags]) (vl-file-copy "source-filename" (vl-filename-mktemp ["pattern" "directory"
(setcfg cfgname cfgval) (vlax-remove-cmd global-name) "destination-filename" [append?]) "extension"]) (vlr-acdb-reactor data callbacks) (vlr-owners reactor)
(vlax-invoke-method obj method list) (vl-file-delete "filename") (write-char num [file-desc]) (vlr-add obj) (vlr-pers reactor)
(vl-file-directory-p "filename") (write-line string [file-desc]) (vlr-added-p obj) (vlr-pers-p reactor)
(vlax-method-applicable-p obj method) Display Control Functions
(vlr-beep-reaction [args]) (vlr-pers-release reactor)
(graphscr) (print [expr [file-desc]]) Selection Set, Object & Symbol (vlr-current-reaction-name)
(vlr-data obj)
(vlr-reaction-names reactor-type)
(vlr-reaction-set reactor event function)
(grdraw from to color [highlight]) (prompt msg)
Object-Handling Functions (grtext [box text [highlight]]) (redraw [ename [mode]]) Table Functions (vlr-data-set obj data) (vlr-reactions reactor)
(grvecs vlist [trans]) (terpri) (vlr-editor-reactor data callbacks) (vlr-reactors reactor-type)
(menucmd string) (textpage)
Selection Set Manipulation Functions (vlr-linker-reactor data callbacks) (vlr-remove reactor)
(vlax-create-object "prog-id")
(menugroup groupname) (textscr) (vl-load-reactors) (vlr-remove-all reactor-type)
(vlax-dump-object obj) (ssadd [ename [ss]]) (ssmemb ename ss)
(prin1 [expr [file-desc]]) (vports) (vlr-object-reactor owners data callbacks) (vlr-trace-reaction any number of arguments)
(vlax-erased-p obj) (ssdel ename ss) (ssname ss index)
(princ [expr [file-desc]]) (vlr-owner-add reactor owner) (vlr-type reactor)
(vlax-get-acad-object) (ssget [mode] [pt1 [pt2]] [pt-list] [filter-list]) (ssnamex ss index)
(vlr-owner-remove reactor owner) (vlr-types)
(vlax-get-object "prog-id") (ssgetfirst) (sssetfirst gripset [pickset])
(vlax-import-type-library :tlb-filename filename User Input Functions (sslength ss)
[ :methods-prefix mprefix :properties-prefix
pprefix :constants-prefix cprefix]) (entsel [msg]) (getorient [pt] [msg]) Object (Entity)-Handling Functions VLX Namespace Functions
(vlax-method-applicable-p obj method) (getangle [pt] [msg]) (getpoint [pt] [msg])
(vlax-object-released-p obj) (getcorner pt [msg]) (getreal [msg]) (entdel ename) (vlax-dump-object obj) VLX Namespace Functions
(vlax-read-enabled-p obj) (getdist [pt] [msg]) (getstring [cr] [msg]) (entget ename [applist]) (vlax-erased-p obj)
(vlax-release-object obj) (getfiled title default ext flags) (initget [bits] [string]) (entlast) (vlax-get-acad-object) (vl-arx-import [function | application]) (vl-exit-with-value value)
(vlax-typeinfo-available-p obj) (getint [msg]) (nentsel [msg]) (entmake [elist]) (vlax-method-applicable-p obj method) (vl-doc-export 'function) (vl-list-exported-functions "appname")
(vlax-write-enabled-p obj) (getkword [msg]) (nentselp [msg] [pt]) (entmakex [elist]) (vlax-object-released-p obj) (vl-doc-import ['function | application]) (vl-list-loaded-vlx)
(entmod elist) (vlax-read-enabled-p obj) (vl-doc-ref symbol) (vl-unload-vlx "appname")
(entnext [ename]) (vlax-release-object obj) (vl-doc-set symbol value) (vlx-loaded-p "appname")
Geometric Functions (entupd ename) (vlax-typeinfo-available-p obj) (vl-exit-with-error "msg")
Property-Handling Functions (handent handle) (vlax-write-enabled-p obj)
(angle pt1 pt2) (osnap pt mode)
(distance pt1 pt2) (polar pt ang dist)
(vlax-get-property obj property) (inters pt1 pt2 pt3 pt4 [onseg]) (textbox elist) Extended Data-Handling Functions Namespace Communication Functions
(vlax-property-available-p obj prop [T])
(vlax-put-property obj property arg) (regapp application) (xdsize lst) Namespace Communication Functions
Conversion Functions (xdroom ename)
(vl-bb-ref 'variable) (vl-load-all "filename")
(angtof string [mode]) (cvunit value from to) (vl-bb-set 'variable value) (vl-propagate 'variable)
(angtos angle [mode [precision]]) (distof string [mode])
Symbol Table & Dictionary-Handling Functions
(ascii string) (itoa int) (dictadd ename symbol newobj) (tblnext table-name [rewind])
(atof string) (rtos number [mode [precision]])
(atoi string) (trans pt from to [disp])
(dictdel ename symbol)
(dictnext ename symbol [rewind])
(tblobjname table-name symbol)
(tblsearch table-name symbol [setnext])
Windows Registry Functions
(chr integer) (dictrename ename oldsym newsym) (vlax-ldata-delete dict key) Windows Registry Functions
(dictsearch ename symbol [setnext]) (vlax-ldata-get dict key [default-data])
Device Access Functions (namedobjdict) (vlax-ldata-list dict) (vlax-product-key) (vl-registry-read reg-key [val-name])
(setview view_description [vport_id]) (vlax-ldata-put dict key data) (vl-registry-delete reg-key [val-name]) (vl-registry-write reg-key [val-name val-data])
(grread [track] [allkeys [curtype]]) (tablet code [row1 row2 row3 direction]) (snvalid sym_name) (vlax-ldata-test data) (vl-registry-descendents reg-key [val-names])
Built with

For more information on AutoCAD Developer Tools and Marketing Programs, go online to www. autodesk.com
Autodesk, the Autodesk logo, AutoCAD, and AutoLISP are registered trademarks, and ObjectARX, the Built with ObjectARX logo, and Visual LISP are trademarks of Autodesk, Inc., in the USA and/or other countries. ActiveX is a trademark of Microsoft Corporation. © 1999 Autodesk, Inc. All rights reserved. 18420-010000-3161