Show TOC

@CASELocate this document in the navigation structure

This function has been deprecated and will not be supported in future releases. It should be replaced with one of the following: CASE_INT, CASE_STRING, CASE_DEC, or IF. The CASE function provides switch-case logic, allowing for the evaluation of a single test value for the purpose of returning one of a multiple number of possible values. The CASE function takes a variable number of parameters, but with a minimum of three. The first parameter is evaluated as an integral number. This value is then treated as a positional value for one of the other parameters to the function, with the second parameter at position 1. The parameter at the position specified by the position parameter is then returned. The data type of the other parameters varies depending on the function’s context. For example, if the context of the function call is a string, the parameters Position1 through PositionN of the function will be treated as strings.
    @CASE (Position To Match, Position1 [, ..., PositionN])
  • Position To Match Required integral number parameter, indicating which of the case parameters the function should return.
  • Position 1 Required parameter, evaluated when the Postion To Match parameter evaluates to 1. The data type is dictated by the context in which the function is called.
  • Position N Optional parameter, evaluated when the Position to Match parameter evaluates to N, where N is the position of the parameter in the function’s parameter list. The data type is dictated by the context in which the function is called.
Supported Return Types
  • Boolean
  • Integral Number
  • Decimal Number
  • String
  • Property