Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » String » FormatRealToString

FormatRealToString


Creates a string from a real number using a proper format.

Name Type Range Description
inReal Real Input real
inIntegerDigitCount Integer 0 - 1000 How many characters the integer part of the input real should have at least
inFractionalDigitCount Integer 0 - 100 How many characters the fractional part of the input real should have
inDecimalMark String The symbol used to separate the integer part from the fractional part of the number
inTrailingCharacter String Defines the trailing character
inForceSignPrinting Bool Forces printing the sign of the number even if the number is positive
inSuffix String Defines a suffix. Generally it is an unit of value (eg. mm)
outString String Output string

Applications

Useful for preparing a number for display or communication with specific number of fractional digits, sign etc.

Errors

This filter can throw an exception to report error. Read how to deal with errors here: Error Handling

Error type Description
DomainError inTrailingCharacter has to be a single character in FormatRealToString.
DomainError inDecimalMark has to be a single character in FormatRealToString.

Complexity Level

This filter is available on Basic Complexity Level.