Skip To Content

esri_label_remove (AutoLISP)

Removes the association between a feature and its text label.

Syntax

(esri_label_remove flname field ename)

Arguments

  • flname | string | required | An existing web feature layer name in the drawing.
  • field | string | required | Feature layer field name associated with the label.
  • ename | entity name | required | The AutoCAD entity name of a feature to remove its label association.

Example usage

Prompts the user to select a feature from the "Parcels" feature layer and attempt to remove its label association from the text entity and the field named "Owner".

(progn
  (setq ename (car (entsel)))
  (esri_label_remove
    "Parcels" 
    "Owner"
    ename 
  )
)

Result example usage

Removes the association between the AutoCAD text entity and the Owner field of the selected feature of the Parcels feature layer and returns a list of true:

(T)

Return values

  • If successful, returns a list of true: (T)
  • If failed, returns a list with the first value of nil and then an associated list containing the key value "Error" and an associated error message as a string: (nil ( "Error" . "<message>"))

Failed return values

A failed return value can occur for any of the following reasons:

  • (nil ("Error" . "Missing required argument."))

    One or more of the required arguments was not supplied.

  • (nil ("Error" . "Feature layer not found."))

    The specified web feature layer value is not a valid web feature layer in the drawing.

  • (nil ("Error" . "Error"))

    There is no association between the selected feature and the specified field.

  • (nil ("Error", "Field not found."))

    No field matches the provided input

  • (nil ("Error", "Invalid or missing drawing object.")

    An entity was not selected.

  • (nil ("Error", "No label found."))

    There were no labels found to remove.