AutoLISP Reference Guide - Autodesk

1 AutoCAD 2013 AutoLISP Reference GuideJanuary 2012 2012 Autodesk , Inc. All Rights Reserved. Except as otherwise permitted by Autodesk , Inc., this publication, or parts thereof, may notbe reproduced in any form, by any method, for any materials included in this publication are reprinted with the permission of the copyright following are registered trademarks or trademarks of Autodesk , Inc., and/or its subsidiaries and/or affiliates in the USA and other countries:123D, 3ds Max, Algor, Alias, Alias (swirl design/logo), AliasStudio, ATC, AUGI, AutoCAD, AutoCAD Learning Assistance, AutoCAD LT, AutoCADS imulator, AutoCAD SQL Extension, AutoCAD SQL Interface, Autodesk , Autodesk Homestyler, Autodesk Intent, Autodesk Inventor, AutodeskMapGuide, Autodesk Streamline, AutoLISP , AutoSketch, AutoSnap, AutoTrack, Backburner, Backdraft, Beast, Beast (design/logo) Built withObjectARX (design/logo), Burn, Buzzsaw, CAiCE, CFdesign, Civil 3D, Cleaner, Cleaner Central, ClearScale, Colour Warper, Combustion,Communication Specification, Constructware, Content Explorer, Creative Bridge, Dancing Baby (image), DesignCenter, Design Doctor, Designer'sToolkit, DesignKids, DesignProf, DesignServer, DesignStudio, Design Web Format, Discreet, DWF, DWG, DWG (design/logo)

2 , DWG Extreme,DWG TrueConvert, DWG TrueView, DWFX, DXF, Ecotect, Evolver, Exposure, Extending the Design Team, Face Robot, FBX, Fempro, Fire, Flame,Flare, Flint, FMDesktop, Freewheel, GDX Driver, Green Building Studio, Heads-up Design, Heidi, Homestyler, HumanIK, IDEA Server, i-drop,Illuminate Labs AB (design/logo), ImageModeler, iMOUT, Incinerator, Inferno, Instructables, Instructables (stylized robot design/logo),Inventor,Inventor LT, Kynapse, Kynogon, LandXplorer, LiquidLight, LiquidLight (design/logo), Lustre, MatchMover, Maya, Mechanical Desktop, Moldflow,Moldflow Plastics Advisers, Moldflow Plastics Insight, Moldflow Plastics Xpert, Moondust, MotionBuilder, Movimento, MPA, MPA (design/logo),MPI, MPI (design/logo), MPX, MPX (design/logo), Mudbox, Multi-Master Editing, Navisworks, ObjectARX, ObjectDBX, Opticore, Pipeplus, Pixlr,Pixlr-o-matic, PolarSnap, PortfolioWall, Powered with Autodesk Technology, Productstream, ProMaterials, RasterDWG, RealDWG, Real-timeRoto, Recognize, Render Queue, Retimer, Reveal, Revit, RiverCAD, Robot, Scaleform, Scaleform GFx, Showcase, Show Me, ShowMotion,SketchBook, Smoke, Softimage, Softimage|XSI (design/logo), Sparks, SteeringWheels, Stitcher, Stone, StormNET, Tinkerbox, ToolClip, Topobase,Toxik, TrustedDWG, U-Vis, ViewCube, Visual, Visual LISP, Voice Reality, Volo, Vtour, WaterNetworks, Wire, Wiretap, WiretapCentral, other brand names, product names or trademarks belong to their respective PUBLICATION AND THE INFORMATION CONTAINED HEREIN IS MADE AVAILABLE BY Autodesk , INC.

3 "AS IS." Autodesk , INC. DISCLAIMSALL WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE REGARDING THESE 1 AutoLISP Functions .. 1 AutoLISP Functions .. 1 Operators .. 1+ (add) .. 1- (subtract) .. 2* (multiply) .. 3/ (divide) .. 4= (equal to) .. 5/= (not equal to) .. 6< (less than) .. 7<= (less than or equal to) .. 8> (greater than) .. 9>= (greater than or equal to) .. 9~ (bitwise NOT) .. 101+ (increment) .. 111- (decrement) .. 12A Functions .. 12abs .. 12acad-pop-dbmod .. 13acad-push-dbmod .. 13acad_strlsort .. 14acad_truecolorcli .. 15acad_truecolordlg .. 16acdimenableupdate .. 17iiiacet-layerp-mode .. 18acet-layerp-mark .. 19alert .. 20alloc .. 21and .. 21angle .. 22angtof .. 23angtos .. 24append .. 25apply .. 26arx .. 26arxload .. 27arxunload .. 28ascii .. 28assoc .. 29atan .. 30atof .. 31atoi.

4 31atom .. 32atoms-family .. 33autoarxload .. 33autoload .. 34B Functions .. 35 Boole .. 35boundp .. 37C Functions .. 38caddr .. 38cadr .. 38car .. 39cdr .. 40chr .. 41close .. 41command .. 42command-s .. 43cond .. 48cons .. 49cos .. 50cvunit .. 50D Functions .. 52defun .. 52defun-q .. 53defun-q-list-ref .. 54defun-q-list-set .. 55dictadd .. 56dictnext .. 58dictremove .. 59iv | Contentsdictrename .. 60dictsearch .. 61distance .. 62distof .. 63dumpallproperties .. 64E Functions .. 67entdel .. 67entget .. 68entlast .. 69entmake .. 70entmakex .. 72entmod .. 73entnext .. 75entsel .. 77entupd .. 78eq .. 80equal .. 81*error* .. 82eval .. 83exit .. 84exp .. 84expand .. 85expt .. 86F Functions .. 86findfile .. 86fix .. 87float .. 88foreach .. 88function .. 89G Functions .. 90gc .. 90gcd .. 91getangle .. 91getcfg .. 93getcname .. 94getcorner .. 94getdist .. 95getenv .. 96getfiled .. 97getint.

5 99getkword .. 100getorient .. 101getpoint .. 102getpropertyvalue .. 103getreal .. 104getstring .. 105 Contents | vgetvar .. 106graphscr .. 106grclear .. 107grdraw .. 107grread .. 108grtext .. 110grvecs .. 112H Functions .. 114handent .. 114I Functions .. 115if .. 115initcommandversion .. 116initdia .. 117initget .. 118ispropertyreadonly .. 123inters .. 124itoa .. 125L Functions .. 126lambda .. 126last .. 127layoutlist .. 127layerstate-addlayers .. 128layerstate-compare .. 129layerstate-delete .. 130layerstate-export .. 130layerstate-getlastrestored .. 131layerstate-getlayers .. 131layerstate-getnames .. 132layerstate-has .. 132layerstate-import .. 133layerstate-importfromdb .. 133layerstate-removelayers .. 134layerstate-rename .. 134layerstate-restore .. 135layerstate-save .. 135length .. 136list .. 137listp .. 138load .. 139log .. 140logand .. 141logior .. 141lsh .. 142M Functions .. 143mapcar.

6 143max .. 144vi | Contentsmem .. 145member .. 146menucmd .. 147min .. 147minusp .. 148N Functions .. 149namedobjdict .. 149nentsel .. 149nentselp .. 151not .. 152nth .. 153null .. 153numberp .. 154O Functions .. 155open .. 155or .. 156osnap .. 157P Functions .. 157polar .. 157prin1 .. 158princ .. 160print .. 161progn .. 161prompt .. 162Q Functions .. 163quit .. 163quote .. 163R Functions .. 164read .. 164read-char .. 165read-line .. 166redraw .. 167regapp .. 168rem .. 168repeat .. 169reverse .. 170rtos .. 171S Functions .. 172set .. 172setcfg .. 173setenv .. 174setpropertyvalue .. 175setq .. 176setvar .. 177setview .. 179sin .. 179 Contents | viisnvalid .. 180sqrt .. 182ssadd .. 183ssdel .. 184ssget .. 185ssgetfirst .. 188sslength .. 189ssmemb .. 189ssname .. 190ssnamex .. 191sssetfirst .. 194startapp .. 196strcase .. 197strcat .. 198strlen .. 198subst .. 199substr .. 200T Functions.

7 201tblnext .. 201tblobjname .. 203tblsearch .. 204terpri .. 205textbox .. 205textpage .. 206textscr .. 206trace .. 207trans .. 208type .. 210U Functions .. 213V Functions .. 213ver .. 213vl-acad-defun .. 214vl-acad-undefun .. 214vl-bb-ref .. 215vl-bb-set .. 215vl-catch-all-apply .. 216vl-catch-all-error-message .. 217vl-catch-all-error-p .. 218vl-cmdf .. 219vl-consp .. 221vl-directory-files .. 221vl-doc-ref .. 222vl-doc-set .. 223vl-every .. 224vl-exit-with-error .. 225vl-exit-with-value .. 226viii | Contentsvl-file-copy .. 227vl-file-delete .. 228vl-file-directory-p .. 229vl-file-rename .. 230vl-file-size .. 230vl-file-systime .. 231vl-filename-base .. 232vl-filename-directory .. 233vl-filename-extension .. 233vl-filename-mktemp .. 234vl-list* .. 235vl-list->string .. 236vl-list-length .. 237vl-load-all .. 238vl-mkdir .. 238vl-member-if .. 239vl-member-if-not .. 240vl-position .. 241vl-prin1-to-string.

8 242vl-princ-to-string .. 242vl-propagate .. 243vl-registry-delete .. 244vl-registry-descendents .. 244vl-registry-read .. 245vl-registry-write .. 246vl-remove .. 247vl-remove-if .. 247vl-remove-if-not .. 248vl-some .. 249vl-sort .. 250vl-sort-i .. 251vl-string->list .. 253vl-string-elt .. 253vl-string-left-trim .. 254vl-string-mismatch .. 254vl-string-position .. 256vl-string-right-trim .. 257vl-string-search .. 257vl-string-subst .. 258vl-string-translate .. 260vl-string-trim .. 260vl-symbol-name .. 261vl-symbol-value .. 262vl-symbolp .. 262vports .. 263W Functions .. 264 Contents | ixwcmatch .. 264while .. 267write-char .. 268write-line .. 268X Functions .. 269xdroom .. 269xdsize .. 270Z Functions .. 271zerop .. 271 Chapter 2 Externally Defined Commands .. 273 Externally Defined Commands .. 273align .. 273cal .. 274mirror3d .. 275rotate3d .. 275solprof .. 276 Index .. 277x | ContentsAutoLISP FunctionsAutoLISP FunctionsThe following is a catalog of the AutoLISP functions available in AutoCAD.

9 The functions are listed this chapter, each listing contains a brief description of the function's useand a function syntax statement showing the order and the type of argumentsrequired by the that any functions, variables, or features not described here or in otherparts of the documentation are not officially supported and are subject to changein future information on syntax, see AutoLISP Function Syntax in the AutoLISPD eveloper's that the value returned by some functions is categorized as indicates you cannot rely on using the value returned from this + (add)Returns the sum of all numbers.(+[numbernumber]..)11 ArgumentsnumberA ValuesThe result of the addition. If you supply only one number argument, thisfunction returns the result of adding it to zero. If you supply no arguments,the function returns (+ 1 2)returns3(+ 1 2 3 ) (+ 1 2 3 ) (subtract)Subtracts the second and following numbers from the first and returns thedifference(-[numbernumber].)

10 ArgumentsnumberA ValuesThe result of the subtraction. If you supply more than two number arguments,this function returns the result of subtracting the sum of the second throughthe last numbers from the first number. If you supply only one numberargument, this function subtracts the number from zero, and returns a negativenumber. Supplying no arguments returns | Chapter 1 AutoLISP Functions(- 50 40)returns10(- 50 ) (- 50 ) (- 8)returns-8* (multiply)Returns the product of all numbers(*[numbernumber]..)Argumentsnumbe rA ValuesThe result of the multiplication. If you supply only one number argument,this function returns the result of multiplying it by one; it returns the no arguments returns (* 2 3)returns6(* 2 ) (* 2 3 ) AutoLISP Functions | (* 3 ) (* 3)returns3/ (divide)Divides the first number by the product of the remaining numbers and returnsthe quotient(/[numbernumber].)