Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

geDeleteHilightGroup

geDeleteHilightGroup( 
hl_groupId
[ g_deleteAll ]
)
=> t / nil 

Description

Deletes the specified highlight group.

Arguments

hl_groupId

The database ID of the highlight group.

g_deleteAll

Optional argument. When t, each highlight object in the group is also deleted unless it belongs to another group. When nil, each highlight object in the group is placed back in the highlight set object list unless it belongs to another group.

The default is nil.

Value Returned

t

The specified highlight group is deleted.

nil

An error occurred and the highlight group is not deleted.

Examples

geDeleteHilightGroup(hlGroupId t)

Related Topics

Highlight Functions


Return to top
 ⠀
X