Share via


Label.extractComment Method

Returns a comment associated with a specified label ID.

Syntax

public str extractComment(str label)

Run On

Called

Parameters

  • label
    Type: str
    A string that specifies the label ID. The string must include the at sign (@) followed by a label file ID and a number.

Return Value

Type: str
A string value that indicates the comment associated with the specified label ID.

Remarks

If you specify a label ID that does not exist, the method returns the specified ID as a string.

If you don't include the at sign (@) in the label parameter value, the method returns the label ID.

See Also

Reference

Label Class