Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Collapse Lisp Functions ReferenceLisp Functions Reference
Lisp Functions by Alphabetical Order
*error*
+ (Addition)
- (Subtraction)
* (Multiplication)
/ (Division)
1+ (Increment)
1- (Decrement)
Equal
Not equal
Greater than
Greater than or equal
Less than
Less than or equal
~ (Bitwise NOT)
abs
acad_colordlg
acad_strlsort
action_tile
add_list
alert
alloc
and
angle
angtof
angtos
append
apply
ascii
assoc
atan
atof
atoi
atom
atoms-family
boole
boundp
car
caaaar ... cddddr
cdr
chr
client_data_tile
close
command
cond
cons
cos
defun
dictadd
dictnext
dictremove
dictrename
dictsearch
dimx_tile
dimy_tile
distance
distof
done_dialog
end_image
end_list
entdel
entget
entlast
entmake
entmakex
entmod
entnext
entsel
entupd
eq
equal
eval
exit
exp
expand
expt
fill_image
findfile
fix
float
foreach
gc
gcd
get_attr
get_tile
getangle
getcfg
getcname
getcorner
getdist
getenv
getfiled
getint
getkword
getorient
getpoint
getreal
getstring
getvar
graphscr
grclear
grdraw
grread
grtext
grvecs
handent
help
if
initget
inters
itoa
lambda
last
length
list
listp
load
load_dialog
log
logand
logior
lsh
mapcar
max
mem
member
menucmd
menugroup
min
minusp
mode_tile
namedobjdict
nentsel
nentselp
new_dialog
not
nth
null
numberp
open
or
osnap
pi (Constant)
polar
prin1
princ
print
progn
prompt
quit
quote
read
read-char
read-line
redraw
regapp
rem
repeat
reverse
rtos
set
set_tile
setcfg
setenv
setfunhelp
setq
setvar
setview
sin
slide_image
snvalid
sqrt
ssadd
ssdel
ssget
sslength
ssmemb
ssname
start_dialog
start_image
start_list
startapp
strcase
strcat
strlen
subst
substr
tan
tblnext
tblobjname
tblsearch
term_dialog
terpri
textbox
textpage
textscr
trans
type
unload_dialog
vector_image
ver
vmon
vports
wcmatch
while
write-char
write-line
xdroom
xdsize
zerop
Hide Table of Contents

Lisp Functions by Alphabetical Order

In the following, an symbol labels an argument description.

For better readability, both lowercase and uppercase characters are used in the names of some functions.


 

Function Description
(*error* string) Defines a custom error-handling function.
Error Message
(* number number ...) Multiplication
(/ number number ...) Division
(/= atom atom ...) Comparison: Not equal
(~ integer) Bitwise NOT
(- number number ...) Subtraction
(+ number number ...) Addition
(<= atom atom ...) Comparison: Less than or equal
(< atom atom ...) Comparison: Less than
(= atom atom ...) Comparison: Equal
(>= atom atom ...) Comparison: Greater than or equal
(> atom atom ...) Comparison: Greater than
(1+ number) Increment
(1- number) Decrement
'object Identical to (quote ...)
(abs number) Returns the absolute value of a number.
(acad_colordlg number [flag]) Displays the color selection dialog box.
Color Number
Buttons Display Flag
(acad_strlsort list) Sorts a list of strings in alphabethical order.
List of Strings to sort
(action_tile key expression) Responds when a dialog box tile is clicked.
Key of a tile
Expression to evalute
(alert string string string) Displays a message box.
Message
Title
System Icon
(alloc integer) Provided for compatibility with other Lisp implementations (memory allocation function). Returns always 0.
(and term term ...) Returns the logical AND of multiple terms in a list.
(angle point_list point_list) Calculates the angle between two points.
Starting point
End point
(angtof string [integer]) Converts an angle to a floating-point number.
Angle
Unit System
(angtos real [integer [integer]]) Converts an angle to a string.
Angle
Mode
Precision
(append list list ...) Adds any number of lists together. Returns a new list.
(apply func_symbol list) Executes a function, where arguments are taken from a list.
(ascii string) Converts the first character of a string into its ASCII-Code, which is returned as integer.
(assoc value assoc_list) Searches an association list assoc_list for key.
(atan number [number]) Returns the arc tangent of an angle supplied in radians.
(atof string) Converts a given string to a floating-point number.
(atoi string) Converts a given string to an integer.
(atoms-family 0 | 1  [string_list]) Returns a list of all atoms currently defined.
(atom term) Returns T (true) if term is an atom.
(boole bit_value integer integer ...) Performs a general bitwise Boolean function.
(boundp value) Tests if the specified atom has a value.
(c????r list) Constructs combinations of car and cdr, up to four levels.
(car list) Returns the first element of a list.
(cdr list) Returns a new list without the first element of a given list
(chr integer) Converts an ASCII code (given as integer) into its equivalent single-character string.
(client_data_tile tile_key data) Associates data with a dialog box tile.
(close FileDescriptor) Closes the specified open file.
File descriptor
(command arguments ...) Executes a built-in command with the arguments supplied.
(cond
    (value value value ... )
    [(value value value ... )] ...
)
Performs a primary conditional function.
(cons value list | atom) Constructs a new list.
(cos number) Returns the cosine of an angle supplied in radians.
(defun symbol argument_list term...) Defines a command or function.
(dictadd dictionary item newobj) Adds a non-graphical object to the specified dictionary.
(dictnext dictionary [flag]) Retrieves the next item in a dictionary.
(dictremove dictionary item) Removes an entry from the specified dictionary.
(dictrename dictionary old new) Renames an item of a dictionary.
(dictsearch dictionary item [next]) Searches a dictionary for an item.
(dimx_tile key) Determines the x-dimension of a dialog box tile.
(dimy_tile key) Determines the y-dimension of a dialog box tile.
(distance point_list point_list) Calculates the distance between two given points.
Starting point
End point
(distof string [integer]) Converts a distance to a floating-point number.
(done_dialog [flag]) Terminates the dialog box.
status
(entdel Ename) Deletes an entity.
(entget Ename [list]) Returns entity information.
(entlast) Returns the last entity added to the drawing database.
(entmake [list]) Creates an entity.
(entmakex list) Creates a new entity (graphical or non-graphical) with a data list.
(entmod list) Modifies an entity.
(entnext [Ename]) Returns the entity name that follows the given entity in the drawing database.
(entsel [string]) Prompts the user to select an entity.
(entupd Ename) Updates a complex entity after modifications.
(eq term term) Evaluates if two terms are identical.
(equal value value [number]) Tests if two expressions have the same result.
(eval value) Returns the result of a Lisp expression.
(exit) Terminates the current application.
(expand integer) Provided for compatibility with other Lisp implementations (memory expansion function). Returns always 0.
(exp number) Returns e raised to the power number, where e is the base of the natural logarithm.
(expt number1 number2) Returns number1 raised to the power number2.
(findfile string [value]) Searches for a file.
File name
Condition
(fix number) Converts a real number to an integer
(float number) Converts a given number into a real number
(foreach symbol list value ...) Steps through a given list assigning each element to the specified symbol and evaluating the specified expression for each element of the list
(gc) Provided for compatibility with other Lisp implementations ("garbage collection"; memory release function). Returns always nil
(gcd number number ...) Returns the greatest common denominator of the given numbers
(get_attr key) Determines the attribute a key of a dialog box is set to
(get_tile key) Determines the value a tile of a dialog box is set to
(getangle [point_list] [string]) Prompts the user to specify an angle
(getcfg string) Retrieves application data from the [APPDATA] section of the appdata.ini file
(getcname string) Retrieves the primary (underscored) name of a built-in command. A primary command has always an English name.
(getcorner point_list [string]) Prompts the user to specify a second corner of an rectangle
(getdist [point] [prompt]) Prompts the user to specify a distance
(getenv [string] [string] [string]) Retrieves a string value assigned to
  • a list containing the environment variables as found in the "CAD Path" section of the application INI file
  • a certain environment variable from the "CAD Path" section of the application INI file,
  • a specific registration within an ASCII configuration file (like an INI or other parameter file), or
  • a system environment variable
(getfiled string string string integer) Provides a dialog for file selection.
Dialog caption
Preset filename
Preset extension
Control flag
(getint [string]) Prompts the user to enter an integer value.
(getkword [string]) Prompts the user to select an option.
(getorient [point_list] [string]) Prompts the user to specify an angle (takes into account ANGBASE).
(getpoint [point_list] [string]) Prompts the user to specify a point.
(getreal [string]) Prompts the user to enter a real number.
(getstring [value] [string]) Prompts the user to enter a string.
(getvar string) Retrieves system variable settings.
Variable name
(graphscr) Closes the Command Window.
(grread [integer [integer]]) Reads from an input device.
Draw mode
Cursor type
(handent string) Returns the entity name to the entity that has the specified reference.
(help [string [string [string]]]) Displays the help window with a specified help topic.
Help file name
Topic
Settings
(if <value> <value>
    [<value> value value [value]
)
Performs a conditional evaluation.
Test expression
Then expression
[Else expression]
(initget [integer] [string]) Initializes the next user input function
(inters point_list point_list point_list point_list [value]) Returns the intersection of two lines, each specified by two endpoints.
(itoa integer) Returns a given integer as a string.
(lambda argument_list value ...) Defines an anonymous function.
(last list) Returns the last element of a list.
(length list) Returns the number of elements in a list.
(listp element) Verifies if element is a list.
(list expression1 ...) Creates a list out of expressions supplied as arguments to the function.
(load_dialog string) Loads a dialog box description file (file of type .dcl).
File name
(load string [value]) Loads an existing Lisp file.
File name
Error expression
(logand integer integer ...) Logical bitwise AND
(logior integer integer ...) Logical bitwise OR
(log number) Returns the natural logarithm of a given number.
(lsh integer integer) Logical bitwise shift
(mapcar func_symb list_1 ... list_n) Operates on successive elements of the lists list_1 ... list_n.
(max number number ...) Returns the largest number.
(mem) Displays the memory status for Lisp. Returns always nil.
(member value list) Searches the given list for an element and returns the remaining portion of the list.
(menugroup string) Verifies that a menu group is loaded.
Menu group name
(min number number ...) Returns the smallest number.
(minusp number) Tests if the number is negative.
(mode_tile key mode) Sets the mode of a dialog box tile.
(namedobjdict) Returns the entity name of the current drawing's named object dictionary, which is the root of all non-graphical objects in the drawing.
(new_dialog dialog_name dialog_id [default_action [position]]) Displays a dialog box.
(not argument) Returns T (true) if argument is nil.
(nth integer list) Returns the nth element of list (n counting starts with 0).
(null argument) Returns T (true) if argument is an empty list.
(numberp argument) Returns T (true) if argument is any kind of number.
(open string string) Opens the specified file to read or write.
File name
File mode can be:
     "r" - Opens file to read
     "w" - Opens file to write
     "a" - Opens file to append
(or term term ...) Returns the logical OR of multiple terms in a list.
(osnap point_list string) Snaps to a significant point on an entity.
pi Specifies the constant 3.141593.
(polar point_list real real) Returns a 3D point.
Point
Angle
Distance
(prin1 [object [FileDescriptor]]) Prints a message in the Command Window or writes it to an open file.
(princ [object [FileDescriptor]]) Prints a message in the Command Window or writes it to an open file.
(print [object [FileDescriptor]]) Prints a message in the Command Window or writes it to a file (like prin1, but with a preceding CR and a space following).
(progn value value ...) Evaluates each expression in succession, in the order in which they are grouped in progn.
(prompt string) Displays a message in the Command Window.
(quit) Terminates (cancels) the current application and returns to the command prompt.
(quote object) Returns object.
(read-char [FileDescriptor]) Reads a single character from either the keyboard buffer or from an open file.
(read-line [FileDescriptor]) Reads a string from the keyboard buffer or from an open file.
(read string) Retrieves the first atom or list from the given string and returns it according to its data type.
(redraw [string [integer]]) Refreshes the current drawing display or redraw an entity.
Entity name
Mode
(regapp string) Registers an application name.
(rem number1 number2) Divides number1 by number2 and returns the remainder.
(repeat integer value ...) Executes a given expression n times.
(reverse list) Reverses the given list and returns a new list.
(rtos real [integer [integer]]) Converts a real number to a string.
Floating-point number
Mode
Precision
(setcfg string string) Writes application data to the [APPDATA] section of the appdata.ini file
(setenv name value) Assigns a new value to a specified environment variable.
(setfunhelp string string string) Sets a help topic belonging to a function.
Function
Topic
Help file name
(set symbol value) Sets the value of a quoted symbol to an expression.
(setq symbol value [symbol value] ...) Sets the value of a symbol to an expression.
(set-tile key value) Sets the value of a dialog box tile.
(setvar string value) Sets a system variable to a specified value.
Variable name
Variable value
(setview list [viewport_id]) Establishes a 3D view for a specified Viewport of the current drawing.
(sin number) Returns the sine of an angle supplied in radians.
(snvalid string [flag]) Tests whether a table entry for a symbol in a drawing database has valid characters.
(sqrt number) Returns the square root of a number.
(ssadd [Ename [SelSet]]) Adds an entity to a selection set.
Entity name
Selection set
(ssdel Ename SelSet) Deletes an entity from a selection set.
Entity name
Selection set
(ssget [string] [point [point]] [point_list] [assoc_list]) Creates a selection set.
Mode
Point
Point
Point list
Filter list
(sslength SelSet) Returns the length of a selection set.
Selection set
(ssmemb Ename SelSet) Verifies if an entity is member of a selection set.
Entity name
Selection set
(ssname SelSet integer) Returns the nth element of a selection set.
Selection set
Index
(start_dialog) Starts the dialog box.
(startapp string [string]) Executes an external OS application.
Application
File name
(strcase string [value]) Converts a given string to a new upper case or lower case string.
(strcat string string ...) Returns a new string by concatenating two or more strings.
(strlen string string ...) Returns the sum of the length (number of characters) of all strings given as argument to the function.
(subst old_element new_element list) Copies a list, substituting old_element with new_element.
(substr string integer [integer]) Returns a new partial string based on a given string.
(tan number) Returns the tangent of an angle supplied in radians.
(tblnext string [value]) Returns the next table entry.
(tblobjname string string) Returns the entity name (Ename) of a given drawing database table entry.
(tblsearch string string) Searches a table entry.
(term_dialog) Terminates all dialog boxes.
(terpri) Outputs a new line in the Command Window.
(textbox list) Returns the corners of a bounding box of a text entity.
(textpage) Opens the Command Window.
(textscr) Opens the Command Window.
(trans point_list value value integer) Transforms a point from one coordinate system to another.
Point
From
To
Transformation
(type object) Returns the data type.
(unload_dialog number) Unloads a dialog box.
ID
(ver) Returns a string containing the information about the current version of the Lisp Interpreter.
(vmon) Provided for compatibility with other Lisp implementations (virtual memory management). Returns always nil.
(vports) Returns a description of all Viewports in the current drawing.
(wcmatch string string) Searches a string using a wild card pattern match.
(while value value ...) Allows iterations to continue until the specified expression evaluates to nil.
(write-char integer [FileDescriptor]) Writes a single character to a file or displays it in the Command Window.
(write-line string [FileDescriptor]) Writes a string to a file or displays it in the Command Window.
(xdroom entity) Determines the free space size (in bytes) available for an extended entity data.
(xdsize list) Determines the size (in bytes) necessary to keep extended entity data for an entity.
(zerop number) Determines whether number is zero (or floating-point zero).

        ^ Top of Page



Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   Lisp Functions by Alphabetical Order
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:



x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2019 SP04

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.