HC_UnDefine_Highlight

int HC_UnDefine_Highlight(int count, Key const keys[], char const *style, char const *options)
int HC_UnDefine_Highlight(int count, Key const keys, char const style, char const options)

UnDefines an existing highlight.

If a style is specified, then only that style will be removed, based on the options. If a style is not specified, then all styles that apply to the matched key-path and options will be removed.

The following choices for options are recognized:

  • Exact - Only removes the highlights along the specified path.
  • Segment - Only removes segment and segment-tree highlights.
  • Geometry - Only removes geometry highlights.
  • Everything - Removes segment and geometry highlights.

The default is ‘exact’.

HC_See Define_Highlight()

Parameters

count: Length of ‘keys’ array in parameter 2

keys: An array of HC_KEYs defining an unambiguous path to the highlighted object

style: The named style to undefine on the specified item, set by Define_Named_Style

options: Options to control the behavior of the function