AutoCAD 2018

https://help.autodesk.com/view/OARX/2018/ENU/
Admin
AutoCAD 2018 is a professional design and drafting software that provides extensive APIs and SDKs...
Tokens:4,903
Snippets:34
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### AutoLISP O Functions

Source: https://help.autodesk.com/view/OARX/2018/ENU?guid=GUID-4C431C76-F9F6-482C-B7C6-B63EB0614DDE

Reference for AutoLISP functions starting with 'O'.

```APIDOC
## open

### Description
Opens a file for access by the AutoLISP I/O functions.

### Method
AutoLISP Function

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## or

### Description
Returns the logical OR of a list of expressions.

### Method
AutoLISP Function

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## osnap

### Description
Returns a 3D point that is the result of applying an Object Snap mode to a specified point.

### Method
AutoLISP Function

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Conversion Functions Reference

Source: https://help.autodesk.com/view/OARX/2018/ENU?guid=GUID-5BDBD4BC-289E-4A49-9BB9-DF6A6147E0FC

Summary descriptions of the AutoLISP conversion functions.

```APIDOC
## Conversion Functions Reference (AutoLISP)

### Description
Provides summary descriptions of the AutoLISP conversion functions.

### Functions

- **(angtof _string [mode]_)**
  - **Description**: Converts a string representing an angle into a real (floating-point) value in radians.
  - **Parameters**:
    - `_string` (string) - Required - The string representing the angle.
    - `mode` (integer) - Optional - The angle mode (e.g., degrees, radians).

- **(angtos _angle [mode [precision]]_)**
  - **Description**: Converts an angular value in radians into a string.
  - **Parameters**:
    - `angle` (real) - Required - The angular value in radians.
    - `mode` (integer) - Optional - The desired output mode for the angle string.
    - `precision` (integer) - Optional - The number of decimal places for the output string.

- **(ascii _string_)**
  - **Description**: Returns the conversion of the first character of a string into its ASCII character code (an integer).
  - **Parameters**:
    - `string` (string) - Required - The input string.

- **(atof _string_)**
  - **Description**: Returns the conversion of a string into a real (floating-point) value.
  - **Parameters**:
    - `string` (string) - Required - The string to convert.

- **(atoi _string_)**
  - **Description**: Returns the conversion of a string into an integer.
  - **Parameters**:
    - `string` (string) - Required - The string to convert.

- **(chr _integer_)**
  - **Description**: Returns the conversion of an integer representing an ASCII character code into a single-character string.
  - **Parameters**:
    - `integer` (integer) - Required - The ASCII character code.

- **(cvunit _value from to_)**
  - **Description**: Converts a value from one unit of measurement to another.
  - **Parameters**:
    - `value` (real) - Required - The value to convert.
    - `from` (string) - Required - The unit of the input value (e.g., "inch", "cm").
    - `to` (string) - Required - The target unit for conversion.

- **(distof _string [mode]_)**
  - **Description**: Converts a string that represents a real (floating-point) value into a real value.
  - **Parameters**:
    - `string` (string) - Required - The string representing the real value.
    - `mode` (integer) - Optional - The unit mode for interpretation.

- **(itoa _int_)**
  - **Description**: Returns the conversion of an integer into a string.
  - **Parameters**:
    - `int` (integer) - Required - The integer to convert.

- **(rtos _number [mode [precision]]_)**
  - **Description**: Converts a number into a string.
  - **Parameters**:
    - `number` (real or integer) - Required - The number to convert.
    - `mode` (integer) - Optional - The format mode for the string representation (e.g., scientific, decimal).
    - `precision` (integer) - Optional - The number of decimal places.

- **(trans _pt from to [disp]_)**
  - **Description**: Translates a point (or a displacement) from one coordinate system to another.
  - **Parameters**:
    - `pt` (list or variant) - Required - The point or displacement to translate.
    - `from` (string) - Required - The source coordinate system (e.g., "WCS", "UCS").
    - `to` (string) - Required - The target coordinate system.
    - `disp` (variant) - Optional - A flag indicating if it's a displacement.

### Related Reference
* angtof (AutoLISP)
* angtos (AutoLISP)
* ascii (AutoLISP)
* atof (AutoLISP)
* atoi (AutoLISP)
* chr (AutoLISP)
* cvunit (AutoLISP)
* distof (AutoLISP)
* itoa (AutoLISP)
* rtos (AutoLISP)
* trans (AutoLISP)
* Functions Reference (AutoLISP)
```

--------------------------------

### AutoLISP Dialog and Utility Functions

Source: https://help.autodesk.com/view/OARX/2018/ENU?guid=GUID-512FDA63-ABA7-4C3C-A2DF-F700C440A7AA

Functions for managing dialog box components and general system operations.

```APIDOC
## Dialog and System Functions

### Description
Functions for controlling dialog box elements and performing system-level operations.

### Functions
- **end_image**: Ends creation of the currently active dialog box image.
- **end_list**: Ends processing of the currently active dialog box list.
- **eq**: Determines whether two expressions are identical.
- **equal**: Determines whether two expressions are equal.
- **eval**: Returns the result of evaluating an AutoLISP expression.
- **exit**: Forces the current application to quit.
- **expand**: Allocates additional memory for AutoLISP.
```

--------------------------------

### VLX Namespace Management Functions

Source: https://help.autodesk.com/view/OARX/2018/ENU?guid=GUID-5784FC6F-82DD-4459-879B-6EC3BD5E88D1

A collection of AutoLISP functions for managing, importing, exporting, and querying separate-namespace VLX applications.

```APIDOC
## VLX Namespace Functions

### Description
Functions to facilitate communication and data management between separate-namespace VLX applications and document namespaces.

### Functions
- **(vl-arx-import [function | application])**: Imports ADS-DEFUN functions into a separate-namespace VLX.
- **(vl-doc-export 'function)**: Makes a function loaded in a VLX namespace available to the current document.
- **(vl-doc-import ['function | application])**: Imports a function previously exported from another separate-namespace VLX.
- **(vl-doc-ref symbol)**: Retrieves the value of a variable from the associated document namespace.
- **(vl-doc-set symbol value)**: Sets the value of a variable in the associated document namespace.
- **(vl-exit-with-error "msg")**: Passes control from a VLX error handler to the *error* function of the associated document namespace.
- **(vl-exit-with-value value)**: Returns a value to the document namespace from which the VLX was invoked.
- **(vl-list-exported-functions ["appname"])**: Lists exported functions for a specific application or all if none specified.
- **(vl-list-loaded-vlx)**: Returns a list of all separate-namespace VLX files associated with the current document.
- **(vl-unload-vlx "appname")**: Unloads a VLX loaded in its own namespace.
- **(vl-vlx-loaded-p "appname")**: Determines if a VLX is loaded in its own namespace.
```

--------------------------------

### AutoLISP Mathematical Functions

Source: https://help.autodesk.com/view/OARX/2018/ENU?guid=GUID-512FDA63-ABA7-4C3C-A2DF-F700C440A7AA

Mathematical operations including exponentiation and constant calculations.

```APIDOC
## Mathematical Functions

### Description
Functions for performing mathematical calculations.

### Functions
- **exp**: Returns the constant e raised to a specified power.
- **expt**: Returns a number raised to a specified power.
```

--------------------------------

### Curve Measurement Functions

Source: https://help.autodesk.com/view/OARX/2018/ENU?guid=GUID-4684C76F-02F7-4989-AA53-C886E528350A

This section provides a reference for various AutoLISP functions used to measure and query properties of curves. These functions are part of the AutoLISP/ActiveX library and are primarily used for geometric analysis within AutoCAD.

```APIDOC
## Curve Measurement Functions Reference (AutoLISP/ActiveX)

### Description
Provides a summary of AutoLISP curve measurement functions for analyzing geometric curves.

### Function List

- **(vlax-curve-getArea _curve-obj_)**
  - **Description**: Returns the area inside the curve.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.

- **(vlax-curve-getClosestPointTo _curve-obj givenPnt [extend]_)**
  - **Description**: Returns the point (in WCS coordinates) on a curve that is nearest to the specified point.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `givenPnt` (list) - The point to find the nearest point to.
    - `extend` (boolean) - Optional. If true, the curve is extended to find the nearest point.

- **(vlax-curve-getClosestPointToProjection _curve-obj givenPnt normal [extend]_)**
  - **Description**: Returns the closest point (in WCS) on a curve after projecting the curve onto a plane.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `givenPnt` (list) - The point to project.
    - `normal` (list) - The normal vector of the projection plane.
    - `extend` (boolean) - Optional. If true, the curve is extended.

- **(vlax-curve-getDistAtParam _curve-obj param_)**
  - **Description**: Returns the length of the curve's segment from the curve's beginning to the specified parameter.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `param` (real) - The parameter value.

- **(vlax-curve-getDistAtPoint _curve-obj point_)**
  - **Description**: Returns the length of the curve's segment between the curve's start point and the specified point.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `point` (list) - The point on the curve.

- **(vlax-curve-getEndParam _curve-obj_)**
  - **Description**: Returns the parameter of the endpoint of the curve.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.

- **(vlax-curve-getEndPoint _curve-obj_)**
  - **Description**: Returns the endpoint (in WCS coordinates) of the curve.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.

- **(vlax-curve-getFirstDeriv _curve-obj param_)**
  - **Description**: Returns the first derivative (in WCS coordinates) of a curve at the specified location.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `param` (real) - The parameter value.

- **(vlax-curve-getParamAtDist _curve-obj point_)**
  - **Description**: Returns the parameter of a curve at the specified distance from the beginning of the curve.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `point` (real) - The distance from the beginning of the curve.

- **(vlax-curve-getParamAtPoint _curve-obj dist_)**
  - **Description**: Returns the parameter of the curve at the point.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `dist` (list) - The point on the curve.

- **(vlax-curve-getPointAtDist _curve-obj dist_)**
  - **Description**: Returns the point (in WCS coordinates) along a curve at the distance specified by the user.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `dist` (real) - The distance along the curve.

- **(vlax-curve-getPointAtParam _curve-obj param_)**
  - **Description**: Determines the point on the curve that corresponds to the _param_ parameter and returns the point.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `param` (real) - The parameter value.

- **(vlax-curve-getSecondDeriv _curve-obj param_)**
  - **Description**: Returns the second derivative (in WCS coordinates) of a curve at the specified location.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
    - `param` (real) - The parameter value.

- **(vlax-curve-getStartParam _curve-obj_)**
  - **Description**: Returns the start parameter on the curve.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.

- **(vlax-curve-getStartPoint _curve-obj_)**
  - **Description**: Returns the start point (in WCS coordinates) of the curve.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.

- **(vlax-curve-isClosed _curve-obj_)**
  - **Description**: Determines if the specified curve is closed (i.e., start point is same as endpoint).
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
  - **Returns**: `T` if the curve is closed, `nil` otherwise.

- **(vlax-curve-isPeriodic _curve-obj_)**
  - **Description**: Determines if the specified curve has an infinite range in both directions and there is a period value _dT,_ such that there is a point on curve at (_u_ + _dT_) = point on curve (_u_), for any parameter _u_.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
  - **Returns**: `T` if the curve is periodic, `nil` otherwise.

- **(vlax-curve-isPlanar _curve-obj_)**
  - **Description**: Determines if there is a plane that contains the curve.
  - **Parameters**: 
    - `_curve-obj_` (object) - The curve object.
  - **Returns**: `T` if the curve is planar, `nil` otherwise.

### Related Concepts
- AutoLISP Extensions Reference (AutoLISP/ActiveX)

### Related Reference
- vlax-curve-getArea (AutoLISP/ActiveX)
- vlax-curve-getClosestPointTo (AutoLISP/ActiveX)
- vlax-curve-getClosestPointToProjection (AutoLISP/ActiveX)
- vlax-curve-getDistAtParam (AutoLISP/ActiveX)
- vlax-curve-getDistAtPoint (AutoLISP/ActiveX)
- vlax-curve-getEndParam (AutoLISP/ActiveX)
- vlax-curve-getEndPoint (AutoLISP/ActiveX)
- vlax-curve-getFirstDeriv (AutoLISP/ActiveX)
- vlax-curve-getParamAtDist (AutoLISP/ActiveX)
- vlax-curve-getParamAtPoint (AutoLISP/ActiveX)
- vlax-curve-getPointAtDist (AutoLISP/ActiveX)
- vlax-curve-getPointAtParam (AutoLISP/ActiveX)
- vlax-curve-getSecondDeriv (AutoLISP/ActiveX)
- vlax-curve-getStartParam (AutoLISP/ActiveX)
- vlax-curve-getStartPoint (AutoLISP/ActiveX)
- vlax-curve-isClosed (AutoLISP/ActiveX)
- vlax-curve-isPeriodic (AutoLISP/ActiveX)
- vlax-curve-isPlanar (AutoLISP/ActiveX)
- Functions Reference (AutoLISP)
```

--------------------------------

### AutoLISP Entity Functions

Source: https://help.autodesk.com/view/OARX/2018/ENU?guid=GUID-512FDA63-ABA7-4C3C-A2DF-F700C440A7AA

Functions for creating, modifying, and retrieving entity data within the drawing database.

```APIDOC
## Entity Management Functions

### Description
Functions used to interact with the drawing database to create, delete, modify, and query entities.

### Functions
- **entdel**: Deletes objects (entities) or restores previously deleted objects.
- **entget**: Retrieves an object's (entity's) definition data.
- **entlast**: Returns the name of the last nondeleted main object (entity) in the drawing.
- **entmake**: Creates a new entity in the drawing.
- **entmakex**: Makes a new object or entity, gives it a handle and entity name, and returns the new entity name.
- **entmod**: Modifies the definition data of an object (entity).
- **entnext**: Returns the name of the next object (entity) in the drawing.
- **entsel**: Prompts the user to select a single object (entity) by specifying a point.
- **entupd**: Updates the screen image of an object (entity).
```

--------------------------------

### zerop Function

Source: https://help.autodesk.com/view/OARX/2018/ENU?guid=GUID-1628C9F6-677D-4C2A-A7C7-51C543B994E7

The zerop function checks if a given number is equal to zero.

```APIDOC
## zerop

### Description
Verifies that a number evaluates to zero.

### Parameters
- **number** (number) - Required - The numeric value to evaluate.
```
Tokens:
Raw