AST_STRIPESCAPES

Remove AST escape sequences from a string

Description:

This function removes AST escape sequences from a supplied string, returning the resulting text as the function value. The behaviour of this function can be controlled by invoking the AST_ESCAPES routine, which can be used to supress or enable the removal of escape sequences by this function.

AST escape sequences are used by the Plot class to modify the appearance and position of sub-strings within a plotted text string. See the "Escape" attribute for further information.

Invocation

RESULT = AST_STRIPESCAPES( TEXT )

Arguments

TEXT
The string to be checked.

Returned Value

AST_STRIPESCAPES = CHARACTER
The modified string. If the AST_ESCAPES routine has been called indicating that escape sequences should not be stripped, then the supplied string is returned without change.
Copyright (C) 2021 East Asian Observatory