hiLayerMatchCyclicStr

hiLayerMatchCyclicStr( 
l_choices
t_layer 
) 
=> l_layerValue 

Description

Returns the layer cyclic value associated with the specified t_layer.

This is a convenience function that is used to search the specified list of icon layer choices (l_choices) for a value matching the t_layer string. This function should only be used for layer cyclic fields.

Arguments

l_choices	List of icon layer lists created from a call to hiCreateLayerCyclicField. This list can be retrieved from form->hiLayerField->choices.
t_layer	String representing the layer you wish to match. This string is in the form of t_layerName (t_layerPurpose). (This format is equivalent to the fourth element of a layer icon value.)

Value Returned

l_layerValue

The cyclic value of the specified layer.

Related Topics

Form and Field Functions

hiCreateLayerCyclicField

Return to top