vlax-ldata-delete

vlax-invoke-method

V Functions

vlax-ldata-get

 

AutoLISP Reference Guide > AutoLISP Functions > V Functions > 

vlax-ldata-delete

Erases LISP data from a drawing dictionary

(vlax-ldata-delete dict key [private])

Arguments

dict

A VLA-object, AutoCAD drawing entity object, or a string naming a global dictionary.

key

A string specifying the dictionary key.

private

If a non-nil value is specified for private and vlax-ldata-delete is called from a separate-namespace VLX, vlax-ldata-delete deletes private LISP data from dict. (See vlax-ldata-get for examples using this argument.)

Return Values

T, if successful; otherwise nil (for example, the data did not exist).

Examples

Add LISP data to a dictionary:

_$ (vlax-ldata-put "dict"
"key" '(1))

(1)

Use vlax-ldata-delete to delete the LISP data:

_$ (vlax-ldata-delete "dict"
"key")

T

If vlax-ldata-delete is called again to remove the same data, it returns nil because the data does not exist in the dictionary:

_$ (vlax-ldata-delete "dict"
"key")

nil