InfoValue_ClearState()

Examples


The InfoValue_ClearState() function defined in the syListObj form is used to clear a specific state 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_ClearState(InfoValue, state)

Parameters

InfoValue – The InfoValue column for the list.

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

[spacer]

Constant

Icon

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. The value true indicates the specific state value had already been cleared. The value false indicates the specific state value was previously set, but is now cleared.


Documentation Feedback