Share
 
 

acet-ui-progress (AutoLISP/Express Tools)

Displays a progress meter.

Supported Platforms: AutoCAD for Windows only; not available in AutoCAD LT for Windows, or on Mac OS and Web

Library: acetutil.arx

Signature

(acet-ui-progress [label [max]])
(acet-ui-progress current)
(acet-ui-progress)
label

Type: String

If provided, a text string that will appear as a label for the progress meter.

max

Type: Integer

If provided, the maximum value in the range to be displayed (starting with 0).

current

Type: Integer

If provided, gives the current value, which should be less than max; positive values are absolute while negative values increment the current position.

Note: If no arguments are provided, the progress meter is removed.

Return Values

Type: Integer, T, or nil

The return value depends on the action performed:

  • Initialize: Returns T if successful, otherwise nil
  • Update: Returns the current progress as an integer
  • Restore: Returns nil

Example

;;  Initialize the meter
(acet-ui-progress "Working:" (length theList))

;;  Process each item
(foreach item theList
  ;;  Perform action
  (doSomethingTo item)

  ;;  Update the meter by one item
  (acet-ui-progress -1)
)

;;  Remove the meter
(acet-ui-progress)

Was this information helpful?