cast() Function

Function

Copy link to clipboard

cast( typeNumber, value )

Converts a value from its existing type to the specified type.

See also: Casting, typeof(), Delete Data Types

Parameters

Copy link to clipboard

Returns

Copy link to clipboard

Any Type

Usage considerations

Copy link to clipboard

Referencing data types

Copy link to clipboard

• To retrieve the type number, use typeof(x), where x is a value of the intended type, or reference a type with type!{namespace}type-name (within single quotes).
• When referencing a data type, consider the impact that deleting the data type has on the expression that references it.

Use in portals

Copy link to clipboard

• In portals, you cannot cast a value to a record type.

Examples

Copy link to clipboard

Casting a value

Copy link to clipboard

1
2
3
4
cast(
  'type!{http://www.appian.com/ae/types/2009}Integer', 
  123.4
)
Copy

Returns 123.

1
cast(1, 123.4)
Copy

Returns 123.

1
cast(typeof(123), 123.4)
Copy

Returns 123. typeof(123) returns 1, the type number for Integer.

Casting a list of values

Copy link to clipboard

Use a!listType to cast a list of values to a certain type of list.

1
2
3
4
cast(
  a!listType(type!Integer),
  {1, 2.0, 3.1, "23", "2.34", true, null}
)
Copy

Returns { 1, 2, 3, 23, 2, 1, null }.

1
2
3
4
cast(
  a!listType(typeof(1.0)),
  { 1, 2.0, 3.1, "23", "2.34", true, null }
)
Copy

Returns { 1, 2.0, 3.1, 23, 2.34, 1, null }. typeof(1.0) returns the type number for Decimal.

Feature compatibility

Copy link to clipboard

Feedback

Copy link to clipboard