geCreateWindowHilightSet

geCreateWindowHilightSet( 
w_windowId 
l_layerPurposePair | t_packetName
[ g_notGlobal ]
)
=> h_hilightSetId / nil 

Description

Creates a highlight set on a window.

The highlight set can be created by specifying a layer purpose pair (LPP) or a packet name. If notGlobal is set, the highlight set must be at the top of the window highlight stack and enabled in order to be drawn.

Arguments

w_windowId	The ID of the window.
l_layerPurposePair | t_packetName
	The layer purpose pair or a packet name.
g_notGlobal	Optional argument that specifies whether the highlight set is added to the global list. Valid Values: t, nil

Value Returned

h_hilightSetId	The database ID of the highlight set is returned.
nil	The LPP or packet name is invalid.

Examples

Creates a highlight set on the metal 1 drawing LPP in window(3).

geCreateWindowHilightSet( window(3) list("metal1" "drawing") nil)

Related Topics

Highlight Functions

Return to top