geIsValidHilightSet

geIsValidHilightSet( 
h_hlSetId 
)
=> t / nil 

Description

Determines whether a highlight set is valid.

A valid highlight set has the format of the h_hlSetId value returned from the geCreateHilightSet function.

Arguments

h_hlSetId

Any highlight set ID returned from geCreateHilightSet.

Value Returned

t	The highlight set is valid.
nil	The highlight set is not valid.

Examples

The following example returns t.

hlSetId = geCreateHilightSet( geGetEditCellView( )list( "hilite" "drawing" ) )

geIsValidHilightSet( hlSetId )

The following example returns nil.

geIsValidHilightSet( geGetEditCellView( ) )

Related Topics

Highlight Functions

geCreateHilightGroup

geCreateHilightSet

geCreateWindowHilightSet

Return to top