V Functions Reference (AutoLISP)

These AutoLISP functions all start with 'V'.

Functions

Note: vla-, vlax-, and vlr- functions are not supported on Mac OS.

• vector_image

  Draws a vector in the currently active dialog box image

• ver

  Returns a string that contains the current AutoLISP version number

• vl-acad-defun

  Defines an AutoLISP function symbol as an external subroutine

• vl-acad-undefun

  Undefines an AutoLISP function symbol so it is no longer available to ObjectARX applications

• vl-arx-import

  Imports ObjectARX/ADSRX functions into a separate-namespace VLX

• vl-bb-ref

  Returns the value of a variable from the blackboard namespace

• vl-bb-set

  Sets a variable in the blackboard namespace

• vl-catch-all-apply

  Passes a list of arguments to a specified function and traps any exceptions

• vl-catch-all-error-message

  Returns a string from an error object

• vl-catch-all-error-p

  Determines whether an argument is an error object returned from vl-catch-all-apply

• vl-cmdf

  Executes an AutoCAD command

• vl-consp

  Determines whether or not a list is nil

• vl-directory-files

  Lists all files in a given directory

• vl-doc-export

  Makes a function available to the current document

• vl-doc-import

  Imports a previously exported function into a VLX namespace

• vl-doc-ref

  Retrieves the value of a variable from the current document's namespace

• vl-doc-set

  Sets the value of a variable in the current document's namespace

• vl-every

  Checks whether the predicate is true for every element combination

• vl-exit-with-error

  Passes control from an error handler to the *error* function of the calling namespace

• vl-exit-with-value

  Returns a value to the function that invoked the *error* handler from another namespace

• vl-file-copy

  Copies or appends the contents of one file to another file

• vl-file-delete

  Deletes a file

• vl-file-directory-p

  Determines if a file name refers to a directory

• vl-file-rename

  Renames a file

• vl-file-size

  Determines the size of a file, in bytes

• vl-file-systime

  Returns last modification time of the specified file

• vl-filename-base

  Returns the name of a file, after stripping out the directory path and extension

• vl-filename-directory

  Returns the directory path of a file, after stripping out the name and extension

• vl-filename-extension

  Returns the extension from a file name, after stripping out the rest of the name

• vl-filename-mktemp

  Calculates a unique file name to be used for a temporary file

• vl-get-resource

  Returns the text stored in a .txt file packaged in a VLX

• vl-list*

  Constructs and returns a list

• vl-list->string

  Combines the characters associated with a list of integers into a string

• vl-list-exported-functions

  Lists exported functions

• vl-list-length

  Calculates list length of a true list

• vl-list-loaded-vlx

  Returns a list of all separate-namespace VLX files associated with the current document

• vl-load-all

  Loads a file into all open AutoCAD documents, and into any document subsequently opened during the current AutoCAD session

• vl-load-com

  Loads the extended AutoLISP functions related to ActiveX support

• vl-load-reactors

  Loads reactor support functions

• vl-member-if-not

  Determines if the predicate is nil for one of the list members

• vl-member-if

  Determines if the predicate is true for one of the list members

• vl-mkdir

  Creates a directory

• vl-position

  Returns the index of the specified list item

• vl-prin1-to-string

  Returns the string representation of LISP data as if it were output by the prin1 function

• vl-princ-to-string

  Returns the string representation of LISP data as if it were output by the princ function

• vl-propagate

  Copies the value of a variable into all open document namespaces (and sets its value in any subsequent drawings opened during the current AutoCAD session)

• vl-registry-delete

  Deletes the specified key or value from the Windows registry or property list file on Mac OS

• vl-registry-descendents

  Returns a list of subkeys or value names for the specified Windows registry key or property list file key on Mac OS

• vl-registry-read

  Returns data stored in the Windows registry or property list file key on Mac OS for the specified key/value pair

• vl-registry-write

  Creates a key in the Windows registry or property list file on Mac OS

• vl-remove-if-not

  Returns all elements of the supplied list that pass the test function

• vl-remove-if

  Returns all elements of the supplied list that fail the test function

• vl-remove

  Removes elements from a list

• vl-some

  Checks whether the predicate is not nil for one element combination

• vl-sort-i

  Sorts the elements in a list according to a given compare function, and returns the element index numbers

• vl-sort

  Sorts the elements in a list according to a given compare function

• vl-string->list

  Converts a string into a list of character codes

• vl-string-elt

  Returns the ASCII representation of the character at a specified position in a string

• vl-string-left-trim

  Removes the specified characters from the beginning of a string

• vl-string-mismatch

  Returns the length of the longest common prefix for two strings, starting at specified positions

• vl-string-position

  Looks for a character with the specified ASCII code in a string

• vl-string-right-trim

  Removes the specified characters from the end of a string

• vl-string-search

  Searches for the specified pattern in a string

• vl-string-subst

  Substitutes one string for another, within a string

• vl-string-translate

  Replaces characters in a string with a specified set of characters

• vl-string-trim

  Removes the specified characters from the beginning and end of a string

• vl-symbol-name

  Returns a string containing the name of a symbol

• vl-symbol-value

  Returns the current value bound to a symbol

• vl-symbolp

  Identifies whether or not a specified object is a symbol

• vl-unload-vlx

  Unload a VLX application that is loaded in its own namespace

• vl-vbaload

  Loads a VBA project

• vl-vbarun

  Runs a VBA macro

• vl-vlx-loaded-p

  Determines whether a separate-namespace VLX is currently loaded

• vlax-3D-point

  Creates ActiveX-compatible (variant) 3D point structure

• vlax-add-cmd

  Adds commands to the AutoCAD built-in command set

• vlax-create-object

  Creates a new instance of an application object

• vlax-curve-getArea

  Returns the area inside the curve

• vlax-curve-getClosestPointTo

  Returns the point (in WCS) on a curve that is nearest to the specified point

• vlax-curve-getClosestPointToProjection

  Returns the closest point (in WCS) on a curve after projecting the curve onto a plane

• vlax-curve-getDistAtParam

  Returns the length of the curve's segment from the curve's beginning to the specified parameter

• vlax-curve-getDistAtPoint

  Returns the length of the curve's segment between the curve's start point and the specified point

• vlax-curve-getEndParam

  Returns the parameter of the endpoint of the curve

• vlax-curve-getEndPoint

  Returns the endpoint (in WCS) of the curve

• vlax-curve-getFirstDeriv

  Returns the first derivative (in WCS) of a curve at the specified location

• vlax-curve-getParamAtDist

  Returns the parameter of a curve at the specified distance from the beginning of the curve

• vlax-curve-getParamAtPoint

  Returns the parameter of the curve at the point

• vlax-curve-getPointAtDist

  Returns the point (in WCS) along a curve at the distance specified by the user

• vlax-curve-getPointAtParam

  Returns the point at the specified parameter value along a curve

• vlax-curve-getSecondDeriv

  Returns the second derivative (in WCS) of a curve at the specified location

• vlax-curve-getStartParam

  Returns the start parameter on the curve

• vlax-curve-getStartPoint

  Returns the start point (in WCS) of the curve

• vlax-curve-isClosed

  Determines if the specified curve is closed (that is, the start point is the same as the endpoint)

• vlax-curve-isPeriodic

  Determines if the specified curve has an infinite range in both directions and there is a period value dT, such that a point on the curve at (u + dT) = point on curve (u), for any parameter u

• vlax-curve-isPlanar

  Determines if there is a plane that contains the curve

• vlax-dump-object

  Lists an object's properties, and optionally, the methods that apply to the object

• vlax-ename->vla-object

  Transforms an entity to a VLA-object

• vlax-erased-p

  Determines whether an object was erased

• vlax-for

  Iterates through a collection of objects, evaluating each expression

• vlax-get-acad-object

  Retrieves the top level AutoCAD application object for the current AutoCAD session

• vlax-get-object

  Returns a running instance of an application object

• vlax-get-or-create-object

  Returns a running instance of an application object, or creates a new instance if the application is not currently running

• vlax-get-property

  Retrieves a VLA-object's property

• vlax-import-type-library

  Imports information from a type library

• vlax-invoke-method

  Calls the specified ActiveX method

• vlax-ldata-delete

  Erases LISP data from a drawing dictionary

• vlax-ldata-get

  Retrieves LISP data from a drawing dictionary or an object

• vlax-ldata-list

  Lists AutoLISP data in a drawing dictionary

• vlax-ldata-put

  Stores LISP data in a drawing dictionary or an object

• vlax-ldata-test

  Determines if data can be saved over a session boundary

• vlax-machine-product-key

  Returns the AutoCAD Windows registry path in the HKLM (HKEY_LOCAL_MACHINE)

• vlax-make-safearray

  Creates a safearray

• vlax-make-variant

  Creates a variant data type

• vlax-map-collection

  Applies a function to all objects in a collection

• vlax-method-applicable-p

  Determines if an object supports a particular method

• vlax-object-released-p

  Determines if an object has been released

• vlax-product-key

  Returns the AutoCAD Windows registry path

• vlax-property-available-p

  Determines if an object has a specified property

• vlax-put-property

  Sets the property of an ActiveX object

• vlax-read-enabled-p

  Determines if an object can be read

• vlax-release-object

  Releases a drawing object

• vlax-remove-cmd

  Removes a single command or a command group

• vlax-safearray->list

  Returns the elements of a safearray in list form

• vlax-safearray-fill

  Stores data in the elements of a safearray

• vlax-safearray-get-dim

  Returns the number of dimensions in a safearray object

• vlax-safearray-get-element

  Returns an element from an array

• vlax-safearray-get-l-bound

  Returns the lower boundary (starting index) of a dimension of an array

• vlax-safearray-get-u-bound

  Returns the upper boundary (end index) of a dimension of an array

• vlax-safearray-put-element

  Adds an element to an array

• vlax-safearray-type

  Returns the data type of a safearray

• vlax-tmatrix

  Returns a suitable representation for a 4 x 4 transformation matrix to be used in VLA methods

• vlax-typeinfo-available-p

  Determines whether TypeLib information is present for the specified type of object

• vlax-user-product-key

  Returns the AutoCAD Windows registry path in the HKCU (HKEY_CURRENT_USER)

• vlax-variant-change-type

  Returns the value of a variant after changing it from one data type to another

• vlax-variant-type

  Determines the data type of a variant

• vlax-variant-value

  Returns the value of a variant

• vlax-vla-object->ename

  Transforms a VLA-object to an AutoLISP entity

• vlax-write-enabled-p

  Determines if an AutoCAD drawing object can be modified

• vlisp-compile

  Compiles AutoLISP source code into a FAS file

• vlr-acdb-reactor

  Constructs a reactor object that notifies when an object is added to, modified in, or erased from a drawing database

• vlr-add

  Enables a disabled reactor object

• vlr-added-p

  Tests to determine if a reactor object is enabled

• vlr-beep-reaction

  Produces a beep sound

• vlr-command-reactor

  Constructs an editor reactor that notifies of a command event

• vlr-current-reaction-name

  Returns the name (symbol) of the current event, if called from within a reactor's callback

• vlr-data

  Returns application-specific data associated with a reactor

• vlr-data-set

  Overwrites application-specific data associated with a reactor

• vlr-deepclone-reactor

  Constructs an editor reactor object that notifies of a deep clone event

• vlr-docmanager-reactor

  Constructs a reactor object that notifies of events relating to drawing documents

• vlr-dwg-reactor

  Constructs an editor reactor object that notifies of a drawing event (for example, opening or closing a drawing file)

• vlr-dxf-reactor

  Constructs an editor reactor object that notifies of an event related to reading or writing a DXF file

• vlr-editor-reactor

  Constructs an editor reactor object

• vlr-insert-reactor

  Constructs an editor reactor object that notifies of an event related to block insertion

• vlr-linker-reactor

  Constructs a reactor object that notifies your application every time an ObjectARX application is loaded or unloaded

• vlr-lisp-reactor

  Constructs an editor reactor object that notifies of a LISP event

• vlr-miscellaneous-reactor

  Constructs an editor reactor object that does not fall under any other editor reactor types

• vlr-mouse-reactor

  Constructs an editor reactor object that notifies of a mouse event (for example, a double-click)

• vlr-notification

  Determines whether or not a reactor will fire if its associated namespace is not active

• vlr-object-reactor

  Constructs a drawing object reactor object

• vlr-owner-add

  Adds an object to the list of owners of an object reactor

• vlr-owner-remove

  Removes an object from the list of owners of an object reactor

• vlr-owners

  Returns the list of owners of an object reactor

• vlr-pers-list

  Returns a list of persistent reactors in the current drawing document

• vlr-pers-p

  Determines whether a reactor is persistent

• vlr-pers

  Makes a reactor persistent

• vlr-pers-release

  Makes a reactor transient

• vlr-reaction-name

  Returns a list of all possible callback conditions for this reactor type

• vlr-reaction-set

  Adds or replaces a callback function in a reactor

• vlr-reactions

  Returns a list of pairs (event-name . callback_function) for the reactor

• vlr-reactors

  Returns a list of existing reactors

• vlr-remove-all

  Disables all reactors of the specified type

• vlr-remove

  Disables a reactor

• vlr-set-notification

  Defines whether a reactor's callback function will execute if its associated namespace is not active

• vlr-sysvar-reactor

  Constructs an editor reactor object that notifies of a change to a system variable

• vlr-toolbar-reactor

  Constructs an editor reactor object that notifies of a change to the bitmaps in a toolbar

• vlr-trace-reaction

  A predefined callback function that prints one or more callback arguments in the Trace window

• vlr-type

  Returns a symbol representing the reactor type

• vlr-types

  Returns a list of all reactor types

• vlr-undo-reactor

  Constructs an editor reactor object that notifies of an undo event

• vlr-wblock-reactor

  Constructs an editor reactor object that notifies of an event related to writing a block

• vlr-window-reactor

  Constructs an editor reactor object that notifies of an event related to moving or sizing an AutoCAD window

• vlr-xref-reactor

  Constructs an editor reactor object that notifies of an event related to attaching or modifying XREFs

• vports

  Returns a list of viewport descriptors for the current viewport configuration