`ToInteger`

This reference topic applies to FQL v4. Go to this page for the latest FQL v10 reference topics.

ToInteger( value )

Description

The ToInteger function converts a value to a numeric integer, if possible.

Attempting to convert a value to a number which has no numeric representation results in an "invalid argument" error.

Parameter Type Definition and Requirements

Parameter	Type	Definition and Requirements
`value`	Any	The value to attempt to convert to an Integer.

value

Any

The value to attempt to convert to an Integer.

An Integer that corresponds to value.

The following query uses ToInteger multiple times to demonstrate how the function converts various kinds of values into integers:

[
  ToInteger(1234.5678),
  ToInteger(1234),
  ToInteger('123'),
]

[ 1234, 1234, 123 ]

Query metrics: