InfoValue_SetState()

The InfoValue_SetState() function defined in the syListObj form is used to set the value of the InfoValue column for a list. The InfoValue is a bitmask field, with several states that are set and retrieved independently.

Syntax

InfoValue_SetState(InfoValue, state)

Parameters

• InfoValue – The InfoValue column for the list.

• state – The state which will be set and displayed by the Information Icon for the list item. The value is an integer that corresponds to one of the following constants:

Constant	Priority	Description
INFOVALUE_ERROR	Highest	The item has an error.
INFOVALUE_WORKFLOWPRESENT		The item is part of a workflow.
INFOVALUE_ONHOLD		The item is on hold.
INFOVALUE_INACTIVE		The item is inactive.
INFOVALUE_VOID		The item has been voided.
INFOVALUE_NOTEATTACHED		A record-level note is attached to the item.
INFOVALUE_CUSTOM1		A general-purpose icon indicating an action should be performed for the item.
INFOVALUE_CUSTOM2	Lowest	A general-purpose icon indicating additional information is available for the item.

Return value

A boolean indicating the state had previously been set. The value true indicates the state had already been set, while the value false indicates it had not.

Comments

While the InfoValue column can keep track of all the individual states, the Information Icon in the list will display the icon for only the highest-priority state that has been set.