This information is part of the Modelica Standard Library maintained by the Modelica Association.

Syntax

(nextIndex, integerNumber) = scanInteger(string, startIndex=1, unsigned=false);

Description

Starts scanning of "string" at position "startIndex". First skips white space and scans afterwards a signed number of type Integer. An Integer starts with an optional '+' or '-', immediately followed by a non-empty sequence of digits.

If successful, the function returns nextIndex = index of character directly after the found Integer number, as well as the Integer value in the second output argument.

If not successful, on return nextIndex = startIndex and the second output argument is zero.

Note, a Real number, such as "123.4", is not treated as an Integer number and scanInteger will return nextIndex = startIndex in this case.

If the optional argument "unsigned" is true, the number shall not start with '+' or '-'. The default of "unsigned" is false.

See also

Strings.Advanced.

(nextIndex, number) = scanInteger(string, startIndex, unsigned)

string	Type: String
startIndex	Default Value: 1 Type: Integer
unsigned	Default Value: false Type: Boolean Description: = true, if number shall not start with '+' or '-'

nextIndex	Type: Integer Description: Index after the found token (success=true) or index at which scanning failed (success=false)
number	Type: Integer Description: Value of Integer number