hiGetCyclicValueString

hiGetCyclicValueString( 
o_cyclic
) 
=> t_value / nil

Description

Returns the current value of a cyclic field as a string. This function returns nil if the specified value is an icon list without the fourth member (optional).

Argument

o_cyclic

Specifies the cyclic field.

Values Returned

t_value	The current value of the cyclic field as a string. The value can be one of the following: A string The string member of a string-icon pair The optional fourth member of an icon list (either a symbol or a string) as a string
nil	The value is an icon list without the fourth member (optional).

Examples

Returns the current values, such as stringValue, stringIconPair1, iconSymbol, and stringIconPair2. Also, returns nil, when the value is an icon list without the fourth member.

form->cyclic->choices = list("stringValue"

               '("stringIconPair1" "app-layout.png")

               '("stringIconPair2" (23448 120 32))

               '(2394 120 32 "iconString1")

               '(2345 120 32 iconSymbol1)

               '(23456 120 32)

               '("app-layout.png" 120 32)

               '("app-layout.png" 120 32 "iconString2")

               list("app-layout.png" 120 32 'iconSymbol2)

               )

form->cyclic->value = "stringValue"

"stringValue"

hiGetCyclicValueString( form->cyclic )

=> "stringValue"

form->cyclic->value = list("stringIconPair1" "app-layout.png")

("stringIconPair1" "app-layout.png")

hiGetCyclicValueString( form->cyclic )

=> "stringIconPair1"

form->cyclic->value = list(2345 120 32 'iconSymbol)

(2345 120 32 iconSymbol)

hiGetCyclicValueString( form->cyclic )

=> "iconSymbol"

form->cyclic->value = '("app-layout.png" 120 32)

("app-layout.png" 124 32)

hiGetCyclicValueString( form->cyclic )

=> nil

form->cyclic->value

("app-layout.png" 124 32)

form->cyclic->value = list("stringIconPair2" list(23448 120 32))

("stringIconPair2" (23448 120 32))

hiGetCyclicValueString( form->cyclic )

=> "stringIconPair2"

Related Topics

Form and Field Functions

Return to top