geIsValidHilightObject

geIsValidHilightObject( 
h_hlObjectId 
)
=> t / nil 

Description

Determines whether the highlighted object is valid.

A valid highlighted object has the format of the g_hlObjectId value returned from any of the geAddHilight functions.

Arguments

h_hlObjectId

Any highlighted object ID returned from any of the geAddHilight functions.

Value Returned

t	The highlighted object is valid.
nil	The highlighted object is not valid.

Examples

The following example returns t.

hlObjectId = geAddHilightPolygon( set1 
list( 0:0 10:0 10:10 0:10 ) )

geIsValidHilightObject( hlObjectId )

The following example returns nil.

geIsValidHilightObject( geGetEditCellView( ) )

Related Topics

Highlight Functions

geAddHilightArc

geAddHilightBlockage

geAddHilightCircle

geAddHilightCurvedPath

geAddHilightCurvedPolygon

geAddHilightDistance

Return to top