The esri_label_get function returns a list containing the entity name of the text entity label linked to a specified feature attribute field of a feature.
Syntax
(esri_label_get field ename)
Arguments
- field| string | required | The feature layer field name.
- ename | AutoCAD entity name | required | The AutoCAD entity name of the linked feature.
Example usage
Attempt to get the entity name of the text entity that is linked to the Owner field of the selected feature.(setq text_EID (car (esri_label_get "Owner" (car (entsel)))))
Result example usage
Returns just the entity name from the list containing the entity name of the text entity that is linked to the Owner field of the selected feature:<Entity name: 1450e1b79f0>
Return values
The following are the possible return values:
- If successful, the function returns a list containing the entity names of the of TEXT, MTEXT, or ATTRIBUTE entity linked to the specified feature attribute field.
- If failed, it returns a list with the first value of nil; then, an associated list is returned 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
The provided field name was invalid, or other errors were present.
- (nil ("Error" . "Missing required
argument."))
One or more of the required arguments was not provided.
- (nil ("Error" . "No label found."))
The selected feature is not in the feature layer.